Skip to main content
POST
/
subscribers_bulk_create
Bulk create subscribers
curl --request POST \
  --url https://api.paubox.net/v1/orca/{username}/subscribers_bulk_create \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '
{
  "subscribers": [
    {
      "email": "jsmith@example.com",
      "first_name": "<string>",
      "last_name": "<string>",
      "custom_fields": [
        {}
      ]
    }
  ],
  "subscription_list_id": "<string>"
}
'
{
  "data": {
    "num_subscribers_added": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.paubox.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

authorization
string
header
required

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

Body

application/json
subscribers
object[]

Array of subscribers to create

subscription_list_id
string

Optional subscription list ID

Response

Subscribers created successfully

data
object