POST api/Campaigns/GetUnsubscribesList

This API allows you to retrieve the email addresses that have been unsubscribed from receiving emails from you.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
StartDate	Starting date range. If you do not provide a date, this will default to three years in the past	date	None.
EndDate	Ending date range. If you do not provide a date, this will default to the current date and time	date	None.

Request Formats

application/json, text/json

Sample:

{
  "StartDate": "2025-10-23T21:19:56.8025817-06:00",
  "EndDate": "2025-10-23T21:19:56.8025817-06:00"
}

application/xml, text/xml

Sample:

<UnsubscribesRequestModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <StartDate>2025-10-23T21:19:56.8025817-06:00</StartDate>
  <EndDate>2025-10-23T21:19:56.8025817-06:00</EndDate>
</UnsubscribesRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

UnsubscribesResponseModel

Name	Description	Type	Additional information
Count	Number of unsubscribe records returned	integer	None.
Unsubscribes	List of unsubscribe records	Collection of Unsubscribe	None.
IsSuccessful	Indicator of whether the request was successful	boolean	None.
ErrorMessage	This will contain details of the error if it was not successful	string	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 3",
  "Count": 1,
  "Unsubscribes": null
}