Skip to main content

​
Base URL

https://api.paubox.net/v1/orca/YOUR_USERNAME Replace YOUR_USERNAME with your API endpoint username.

​
Authorization

Include an Authorization header with every request: Authorization: Token token=YOUR_API_KEY Replace YOUR_API_KEY with your API key. Generate your 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/YOUR_USERNAME/subscribers \
  -H 'Authorization: Token token=YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "subscriber": {
      "email": "recipient@example.com",
      "first_name": "Jane",
      "last_name": "Smith"
    }
  }'

​
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

​
Community & support

Q&A

Ask usage questions in the Paubox Community.

Ideas

Propose features and improvements.
Never post PHI, recipient addresses, or message content in public threads. Account, billing, or anything sensitive goes to support@paubox.com.