Create Unsubscribe Action

Bulk-unsubscribe a collection of contacts from email. The action runs asynchronously — poll the returned record with GET /api/v2/contacts/unsubscribe_actions/{id} to track progress via target_count and performed_count.
Exactly one target selection must be supplied: stable_id, stored_filter_id (alias filter_id), target_ids, or target_all. Returns 422 if none is provided or if the supplied value is invalid.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Body Params

Information about a new Unsubscribe Action

contacts_unsubscribe_action
object

Contacts Unsubscribe Actions

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json