API Reference
Help Center

Create an unsubscriber

post
https://api.ycloud.com/v2/unsubscribers

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

Type of unsubscriber.

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

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

string
enum
required

Channel of unsubscriber.

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

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

Response

Updated 12 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 months ago