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


Replace <USERNAME> with your API endpoint username


Use authorization header in request: authorization: Token token=<API_KEY>

Replace <API_KEY> with your API key

Find your <API_KEY> here (note: each API Key is displayed only once upon creation):

Look in the address bar from the email builder.

Example call

curl -X POST \<USERNAME>/subscribers\
-H 'authorization: Token token=<API_KEY>' \
-H 'content-type: application/json' \
-d '{
"subscriber": {
"email": "",
"first_name": "test",
"last_name": "example"

Date format

Dates are passed as ISO8601 strings with UTC timezone

How to find id parameters for subscription_lists_id, campaign_mailing_id, etc.

Finding parameter values in the web dashboard

Standard HTTP response codes

Status CodeStatus Message
200Service Ok
400Bad Request
404Not Found
500, 502, 503, 504Server Error