Skip to main content
POST
Bulk unsubscribe a dynamic list

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[]

UUIDs of specific subscribers to update. When present the request is handled synchronously and every other field is ignored.

from_subscription_list_id
string

UUID of the list whose members are being updated. Required when subscriber_ids is omitted. On the bulk_global_* endpoints this is a subscription list UUID; on the dynamic_bulk_* endpoints it is a dynamic list UUID.

Search term used to narrow the list's members. Defaults to * (all members) on the bulk_global_* endpoints.

filters
string

URL-encoded JSON describing additional subscriber filters, as generated by the subscriber search in the Marketing dashboard. The decoded value is an array of filter groups, each group an array of {"field": ..., "op": ..., "terms": [...]} objects. Ignored by the dynamic_bulk_* endpoints, which use the filters saved on the dynamic list.

except_ids
string[]

UUIDs of subscribers to exclude from the operation. Use this to express "select all except these".

Response

A job ID in select-all mode, or the affected subscribers when subscriber_ids was supplied.

data
object
errors
string

Error message, present only when the operation failed