Skip to main content

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.

​
Base URL

https://api.paubox.net/v1/orca/<USERNAME> Replace <USERNAME> with your API endpoint username

​
Authorization

Use authorization header in request: authorization: Token token=<API_KEY> Replace <API_KEY> with your API key Create your <API_KEY> on the Paubox Marketing > Settings page (note: each API Key is displayed only once upon creation):

​
Example call

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"
    }
  }'

​
Date format

Dates are passed as ISO8601 strings with UTC timezone

​
Finding id parameters for subscription_list_id, campaign_mailing_id, etc.

Finding parameter values in the web dashboard