Skip to main content
POST
/
subscription_lists
Create subscription list
curl --request POST \
  --url https://api.paubox.net/v1/orca/{username}/subscription_lists \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '
{
  "name": "Newsletter Subscribers"
}
'
{
  "data": {
    "id": "<string>",
    "type": "subscription_list",
    "attributes": {
      "name": "<string>",
      "is_default": true,
      "subscriber_count": 123,
      "form_id": "<string>"
    }
  }
}

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.

Authorizations

​
authorization
string
header
required

Token-based authentication. Use format: "Token token=<API_KEY>" where <API_KEY> is your API key

Body

application/json
​
name
string
required

Name of the subscription list (cannot be 'default')

Response

Subscription list created successfully

​
data
object