Unsubscribe
Add contacts to an unsubscribe group
Moves contacts out of an unsubscribe group's audience and returns the number added and the number skipped.
Moves contacts out of an unsubscribe group's audience and returns the number added and the number skipped. Leaving a group stops that group's sends to the contact on every channel. Each member is a contact ID, an email address, or a phone number; an address no contact holds gets a new contact, so an import from another email service needs no contacts first.
Authorization
apiKey x-api-key<token>
In: header
Path Parameters
id*string
Match
^unsub_[0-9a-hjkmnp-tv-z]{16,24}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
members*array<||>
Items
1 <= itemssource?|null
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/unsubscribe-groups/string/members" \ -H "Content-Type: application/json" \ -d '{ "members": [ { "contactId": "string" } ] }'{ "added": 0, "skipped": 0}