List unsubscribers

get

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

Returns a paginated list of unsubscribers.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

int32

1 to 100

Defaults to 1

Page number of the results to be returned, 1-based.

limit

int32

1 to 100

Defaults to 10

A limit on the number of results to be returned, or number of results per page, between 1 and 100, defaults to 10.

includeTotal

boolean

Defaults to false

Return results inside an object that contains the total result count or not.

pageAfter

string

A cursor to fetch the next page in cursor pagination. For example, if you make a list request, receive 100 objects and cursor.after=id:foo, your subsequent call can include pageAfter=id:foo in order to fetch the next page of the list.

filter.customer

string

The customer who has opted out.

filter.channel

string

enum

Channel of unsubscriber.

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

Allowed:

filter.regionCode

string

Region code, formatted in ISO 3166-1 alpha-2 country code.

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully retrieved a paginated list of objects.