{
"offset": 1,
"limit": 2,
"length": 1,
"total": 1,
"items": [
{
"type": "PHONE_NUMBER",
"customer": "+16315551111",
"channel": "whatsapp",
"regionCode": "US",
"source": "Whatsapp",
"createTime": "2022-06-01T12:00:00.000Z"
}
],
"cursor": {
"after": "id:foo"
}
}List unsubscribers
Returns a paginated list of unsubscribers.
{
"offset": 1,
"limit": 2,
"length": 1,
"total": 1,
"items": [
{
"type": "PHONE_NUMBER",
"customer": "+16315551111",
"channel": "whatsapp",
"regionCode": "US",
"source": "Whatsapp",
"createTime": "2022-06-01T12:00:00.000Z"
}
],
"cursor": {
"after": "id:foo"
}
}Authorizations
Query Parameters
Page number of the results to be returned, 1-based.
1 <= x <= 100A limit on the number of results to be returned, or number of results per page, between 1 and 100, defaults to 10.
1 <= x <= 100Return results inside an object that contains the total result count or not.
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.
"id:foo"
The customer who has opted out.
"+16315551111"
Channel of unsubscriber.
whatsapp: Indicates that the customer opts out of receiving WhatsApp messages from your business.
whatsapp Region code, formatted in ISO 3166-1 alpha-2 country code.
Response
Successfully retrieved a paginated list of objects.
Represents a given page of unsubscriber objects.
The position of the item this page starts from, zero-based. e.g., the 11th item is at offset 10.
x >= 0A limit on the number of items to be returned, between 1 and 100, defaults to 10.
x >= 1The actual number of items in the page.
x >= 0The total number of items. This field is returned only when the request parameter includeTotal is set to true.
x >= 0An array containing unsubscriber objects.
Show child attributes
Show child attributes
A cursor object is returned only if the endpoint you requested supports cursor pagination.
Show child attributes
Show child attributes