Get information about all unsubscribe entries

1 min

GET

https://api.campaign.episerver.net/rest/{clientId}/unsubscribes

Get detailed information about all unsubscribe entries of multiple recipients, such as unsubscribe reason or date and time of creation.

clientIdstringClient ID

offsetinteger<int32>Starting point of the result list Default value : 0

limitinteger<int32>Maximum number of unsubscribe entries Default value : 100

recipientIdsarrayComma-separated list of recipient IDs

mediaTypestringMedia type of the delivery channelDefault value : GLOBAL

sortstringSort result by specific criteria

directionstringSort order

recipientListIdinteger<int64>ID of the recipient list to which the recipients are assigned (only if recipient list based unsubscribe is set)

acceptstringGenerated from available response content types

200The unsubscribes were retrieved successfully (empty result if none was found).

400Invalid limit request. Change the limit to less than 10000.

curl --request GET \
     --url 'https://api.campaign.episerver.net/rest/{clientId}/unsubscribes?sort=created' \
     --header 'accept: application/json'