Skip to main content
DELETE

Authorizations

X-API-Key
string
header
required

Path Parameters

customer
string
required

The customer who has opted out.

Example:

"+16315551111"

channel
enum<string>
required

Channel of unsubscriber.

  • whatsapp: Indicates that the customer opts out of receiving WhatsApp messages from your business.
Available options:
whatsapp

Response

Successfully deleted the 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
enum<string>

Type of unsubscriber.

  • PHONE_NUMBER: Indicates that the customer is a phone number in E.164 format.
Available options:
PHONE_NUMBER
customer
string

The customer who has opted out. For type=PHONE_NUMBER, it should be a phone number in E.164 format.

Example:

"+16315551111"

channel
enum<string>

Channel of unsubscriber.

  • whatsapp: Indicates that the customer opts out of receiving WhatsApp messages from your business.
Available options:
whatsapp
regionCode
string

The customer's region code, formatted in ISO 3166-1 alpha-2 country code.

Example:

"US"

source
enum<string>

The source from which a customer resumed their subscription

  • Whatsapp: The customer resumed their subscription on the whatsapp client
  • API: You remove the customer from the unsubscribe list through the OpenAPI of YCloud
  • Manual: You remove the customer from the unsubscribe list on the Contact page of YCloud.
Available options:
Whatsapp,
API,
Manual
Example:

"Whatsapp"

createTime
string<date-time>

The time at which this object was created, formatted in RFC 3339. e.g., 2022-06-01T12:00:00.000Z.

Example:

"2022-06-01T12:00:00.000Z"