Unsubscribe

Remove contacts from an unsubscribe group

Returns contacts to an unsubscribe group's audience and returns the number removed.

DELETE
/v1/unsubscribe-groups/{id}/members

Returns contacts to an unsubscribe group's audience and returns the number removed. Each member is a contact ID, an email address, or a phone number; an address no contact holds is skipped.

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<||>
Items1 <= items

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/unsubscribe-groups/string/members" \  -H "Content-Type: application/json" \  -d '{    "members": [      {        "contactId": "string"      }    ]  }'
{  "removed": 0}

Related documentation