{
"type": "PHONE_NUMBER",
"customer": "+16315551111",
"channel": "whatsapp",
"regionCode": "US",
"source": "Whatsapp",
"createTime": "2022-06-01T12:00:00.000Z"
}Create an unsubscriber
Creates an unsubscriber. An unsubscriber is a configuration item representing that customers opt out of receiving messages from your business. A customer and a channel form a unique identifier for an unsubscriber.
{
"type": "PHONE_NUMBER",
"customer": "+16315551111",
"channel": "whatsapp",
"regionCode": "US",
"source": "Whatsapp",
"createTime": "2022-06-01T12:00:00.000Z"
}Authorizations
Body
The type of unsubscriber identifier. Currently only PHONE_NUMBER is supported, indicating that the customer field contains a phone number in E.164 format.
PHONE_NUMBER The communication channel from which the customer is unsubscribing. Currently only whatsapp is supported, indicating the customer opts out of receiving WhatsApp messages from your business.
whatsapp The customer's region code, formatted in ISO 3166-1 alpha-2 country code.
"US"
Response
Successfully created an unsubscriber.
An unsubscriber is a configuration item representing that customers opt out of receiving messages from your business. A customer and a channel form a unique identifier for an unsubscriber.
Channel of unsubscriber.
whatsapp: Indicates that the customer opts out of receiving WhatsApp messages from your business.
whatsapp The customer's region code, formatted in ISO 3166-1 alpha-2 country code.
"US"
The source from which a customer resumed their subscription
Whatsapp: The customer resumed their subscription on the whatsapp clientAPI: You remove the customer from the unsubscribe list through the OpenAPI of YCloudManual: You remove the customer from the unsubscribe list on the Contact page of YCloud.
Whatsapp, API, Manual "Whatsapp"