Skip to main content
POST
Subscribe subscribers

Authorizations

authorization
string
header
required

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

Body

application/json
subscriber_ids
string[]
required

UUIDs of the subscribers to update

subscription_list_ids
string[]

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.

The affected subscribers in JSON:API form. Returned with HTTP 200; on failure the body carries errors instead of data.

data
object[]
errors
string

Error message, present only when the operation failed