List the unsubscribes of a campaign

List the contacts that unsubscribed through a campaign, with the reason they gave. This is the v3 equivalent of the v1 campaign_report_unsubscription_list action.

Only unsubscribes attributed to a message of the campaign are reported; unsubscribes recorded without a message (for example from an automation) are not. The response carries no meta.total.

Requires the Campaigns feature and access to the campaign; a campaign the user cannot see is reported as 404 so the endpoint does not disclose which campaign ids exist.

Path Params
int32
required

id of the campaign to report on

Query Params
int32
≤ 100
Defaults to 20

Number of rows to return. Digits only, 1 or greater, and no greater than 100; anything else is a 422.

int32
Defaults to 0

Number of rows to skip. Digits only and non-negative.

int32
Defaults to 0

Report on a single message of a split campaign. Defaults to 0, which reports every campaign-level unsubscribe.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json