v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB

Unsubscribers

List unsubscribers

Returns a paginated list of unsubscribers.

get/unsubscribers

Query parameters

pageinteger

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

limitinteger

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

includeTotalboolean

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

pageAfterstring

Example:id:foo

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.customerstring

The customer who has opted out.

Example:+16315551111

filter.channel'whatsapp'

Channel of unsubscriber.

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

filter.regionCodestring

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

Response

Successfully retrieved a paginated list of objects.

offsetinteger required

The position of the item this page starts from, zero-based. e.g., the 11th item is at offset 10.

limitinteger required

A limit on the number of items to be returned, between 1 and 100, defaults to 10.

lengthinteger required

The actual number of items in the page.

totalinteger

The total number of items. This field is returned only when the request parameter includeTotal is set to true.

itemsobject[]