subscriptions

Bulk global unsubscribe

Globally opts out every subscriber in a subscription list without having to enumerate them.

This endpoint has two modes:

  • Explicit — supply subscriber_ids and the request behaves exactly like POST /subscriptions/unsubscribe, returning the affected subscribers synchronously.
  • Select-all — omit subscriber_ids and supply from_subscription_list_id. Every subscriber matching search and filters in that list, minus except_ids, is queued for processing in the background and a Sidekiq job ID (jid) is returned immediately.

In select-all mode from_subscription_list_id is required and must be a subscription list UUID. Globally opting a subscriber out suppresses all future marketing email to them, across every list.

post/subscriptions/bulk_global_unsubscribe

Request

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

Request body

subscriber_idsstring[]

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

from_subscription_list_idstring

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.

searchstring

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

filtersstring

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

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.

errorsstring

Error message, present only when the operation failed

Changes

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