POST GET exports/emailUnsubscribes
Get unsubscribe data across email campaigns. Date range cannot span more than 90 days.
* required
Parameters
| Name | Type | Description |
|---|---|---|
| startDate * | datetime | Unsubscribes after this date |
| endDate * | datetime | Unsubscribes before this date |
| fields | string |
Comma-separated list of fields to return. Available fields: id, emailID, parentEmailID, dateUnsubscribed, contactID, email
id, emailID, dateUnsubscribed, contactID, email
|
Response Data
| Name | Type | Description |
|---|---|---|
| jobID | integer | ID of export job. Use to check the status of the job at /exports/jobStatus |
Permissions
Method requires the Client admin permission
Example Calls
Unsubscribes in past 30 days
GET
/exports/emailUnsubscribes?startDate=2024-10-22&endDate=2024-11-21
cURL
Copy
Response Data
Report Columns
| Name | Type | Description |
|---|---|---|
| id | string | Unique ID of unsubscribe record |
| emailID | integer | ID of email record |
| parentEmailID | integer | ID of parent email record |
| dateUnsubscribed | datetime | Date unsubscribed was logged |
| contactID | integer | ID of contact record |
| string | Email address of contact record |
Sample Report
"id" "emailID" "dateUnsubscribed" "contactID" "email" "123456_26030519" "123456" "2013-02-10 05:05:00.0" "26030519" "john.doe@example.com" "123456_26030520" "123456" "2013-02-10 05:06:00.0" "26030520" "jane.doe@example.com"
API Console
The console uses production data, so BE CAREFUL!
GET
exports/emailUnsubscribes