Sign in
latestOpenAPI 3.1.02026-08-1039111206.0 KB

c53422ebb833

Unsubscribed Contacts

List Unsubscribed Contacts

Retrieves a paginated list of all contacts who have unsubscribed from a specific program's Outreach communications.

get/Advertisers/{AccountSID}/Campaigns/{CampaignId}/UnsubscribedContacts

Path parameters

AccountSIDstring required
CampaignIdinteger required

The unique identifier for the program.

Query parameters

PartnerIdinteger

Filter by partner ID.

UserEmailstring email

Filter by a specific user email.

Pageinteger

The page number to retrieve, starting at 0.

PageSizeinteger

The number of items per page. Maximum is 1000.

Response

A paginated list of unsubscribed contacts.

Pageinteger

The current page number. Starts at 0.

NumPagesinteger

The total number of pages available.

PageSizeinteger

The number of items per page. The maximum is 1000.

Totalinteger

The total number of unsubscribed contact records.

Startinteger

The index of the first item on the current page.

Endinteger

The index of the last item on the current page.

Uristring uri-reference

The URI for the current page of results.

FirstPageUristring uri-reference

The URI for the first page of results.

PreviousPageUristring uri-reference nullable

The URI for the previous page of results, if any.

NextPageUristring uri-reference nullable

The URI for the next page of results, if any.

LastPageUristring uri-reference

The URI for the last page of results.