Introduction
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
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
Standard HTTP response codes
Status Code | Status Message |
---|---|
200 | Service Ok |
400 | Bad Request |
401 | Unauthorized |
404 | Not Found |
500, 502, 503, 504 | Server Error |