Create subscriber

curl --request POST \
  --url https://api.paubox.net/v1/orca/{username}/subscribers \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '
{
  "subscriber": {
    "email": "test@example.com",
    "first_name": "test",
    "last_name": "example"
  }
}
'

{
  "data": {
    "id": "<string>",
    "attributes": {
      "email": "jsmith@example.com",
      "unsubscribed": true,
      "first_name": "<string>",
      "last_name": "<string>"
    }
  }
}

Marketing · Subscribers

Create a subscriber

Creates a subscriber record. Adds record to subscription list if specified otherwise adds to all contacts.

Example curl command:

curl -X POST \
https://api.paubox.net/v1/orca/<USERNAME>/subscribers \
  -H 'authorization: Token token=<API_KEY>' \
  -H 'content-type: application/json' \
  -d '{
    "subscriber": {
        "email": "test@example.com",
        "first_name": "test",
        "last_name": "example"
    }
  }'

POST

subscribers

Create subscriber

curl --request POST \
  --url https://api.paubox.net/v1/orca/{username}/subscribers \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '
{
  "subscriber": {
    "email": "test@example.com",
    "first_name": "test",
    "last_name": "example"
  }
}
'

{
  "data": {
    "id": "<string>",
    "attributes": {
      "email": "jsmith@example.com",
      "unsubscribed": true,
      "first_name": "<string>",
      "last_name": "<string>"
    }
  }
}

Authorizations

authorization

string

header

required

Token-based authentication. Use format: "Token token=<API_KEY>" where <API_KEY> is your API key

Body

application/json

subscriber

object

Show child attributes

subscription_list_id

string

Optional subscription list ID

Response

Subscriber created successfully

data

object

Show child attributes

List subscribers

Get a subscriber

⌘I