subscriptions

Unsubscribe subscribers

Unsubscribes one or more subscribers, identified by their UUIDs.

When subscription_list_ids is supplied, the matching subscriptions are stamped with unsubscribed_at and the subscribers remain subscribed to every other list. When it is omitted, the subscribers are globally opted out by stamping opted_out_on, which suppresses all future marketing email to them.

Example curl command:

curl -X POST \
https://api.paubox.com/v1/marketing/subscriptions/unsubscribe \
  -H 'authorization: Token token=YOUR_API_KEY' \
  -H 'content-type: application/json' \
  -d '{
    "subscriber_ids": ["8f14e45f-ceea-467a-9f2c-4b3d2a1e5c60"],
    "subscription_list_ids": ["123e4567-e89b-12d3-a456-426614174000"]
  }'
post/subscriptions/unsubscribe

Request

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

Request body

subscriber_idsstring[] required

UUIDs of the subscribers to update

subscription_list_idsstring[]

UUIDs of the subscription lists to update the subscribers on. Omit to act on the subscribers' global opt-out instead.

Response

The affected subscribers. If the operation raises, the response is still 200 but the body contains an errors string.

errorsstring

Error message, present only when the operation failed

Changes

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