Unsubscribe a contact from all subscriptions
Unsubscribe a contact from all email subscriptions.
Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The unique identifier of the subscriber to unsubscribe from all communication preferences.
Query Parameters
The communication channel to unsubscribe from. Must be 'EMAIL'.
EMAIL An optional integer representing the business unit ID. It is used to specify the business unit context for the operation.
A boolean flag indicating whether to include detailed information in the response. Defaults to false.
Response
successful operation
The date and time when the operation was completed.
An array of results from the operation.
The date and time when the operation started.
Indicates the current status of the operation, with possible values: PENDING, PROCESSING, CANCELED, COMPLETE.
CANCELED, COMPLETE, PENDING, PROCESSING A list of errors that occurred during the operation.
Contains URLs related to the response, such as documentation or resources.
The number of errors that occurred during the operation.
The date and time when the request was made.