General information

All Paubox Marketing customers have access to the Paubox Marketing API to automate various tasks.

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

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