Technology Partners

POST Unsubscribe Contacts

Changed on

Use to unsubscribe contacts from partner client accounts. Identify the contacts to unsubscribe using the email_address parameter. To unsubscribe a single contact from all partner client accounts, specify the contacts email_address and set the global_unsubscribe parameter to true.

post/partner/accounts/{encoded_account_id}/contacts/unsubscribe

Request

  • Base URL
    https://api.cc.email/v3
  • URL
    https://api.cc.email/v3/partner/accounts/{encoded_account_id}/contacts/unsubscribe
  • Auth
    OAuth 2 and API key in header x-api-key
    Implicit: https://v3api-partner.auth.us-east-1.amazoncognito.com/oauth2/token

Path parameters

encoded_account_idstring required

The encoded account ID that uniquely identifies the partner's client account.

Request body

email_addressesstring[]

Array of email addresses to unsubscribe.

update_source'Account' | 'Contact' | 'System' required

Required parameter to specify the update source performing the unsubscribe.

opt_out_reasonstring

Optional parameter to specify the reason for the unsubscribe.

delete_contactsboolean

Optional parameter to specify if the contact(s) should be soft-deleted as part of the unsubscribe.

global_unsubscribeboolean

Optional parameter to specify if the contact's email address should be unsubscribed from all partner child accounts. When specified only a single email address in the email_addresses array can be specified.

Response

Contacts were successfully unsubscribed

unsubscribed_countinteger

The number of contacts that were successfully unsubscribed.

Example response

{
  "unsubscribed_count": 5
}

Changes