subscriptions

Create a subscription

Subscribes an existing subscriber to an existing subscription list.

Creating a subscription fires any drip campaign configured with a subscription_created trigger on that list.

A subscriber may only be subscribed to a given list once; a duplicate request fails validation.

Note on subscriber_id: this field takes the subscriber's internal numeric ID, not the UUID returned by the subscriber endpoints. To add a subscriber to a list by UUID, use POST /subscribers with a subscription_list_id, or POST /subscriptions/subscribe to re-subscribe an existing subscription.

Example curl command:

curl -X POST \
https://api.paubox.com/v1/marketing/subscriptions \
  -H 'authorization: Token token=YOUR_API_KEY' \
  -H 'content-type: application/json' \
  -d '{
    "subscription": {
        "subscription_list_id": "123e4567-e89b-12d3-a456-426614174000",
        "subscriber_id": 4821
    }
  }'
post/subscriptions

Request

  • Base URL: https://api.paubox.com/v1/marketing
  • URL: https://api.paubox.com/v1/marketing/subscriptions
  • Auth: API key in header authorization

Request body

Response

Subscription created. If validation fails the response is still 200 but the body contains an errors array instead of data.

errorsstring[]

Validation messages, present only when the create failed

Changes

No recorded changes to this operation across all 1 revision of this API.