Unsubsribe Activities Report | Constant Contact Developer

Unsubscribe Activites Report

Use this endpoint to retrieve a list of contacts that unsubscribed (opted-out) from a SENT email campaign.

Methods:

Click a method to view its documentation

DescriptionTOP

Privileges required: contacts:read

Retrieve a list of contacts that unsubscribed from an email campaign specified by the campaignId path parameter. Use the created_since query parameter to retrieve only the contacts that unsubscribed on or after the date/time specified. This is useful for sync'ing tracking data across applications.

NOTE: Tracking information is only available for SENT email campaigns.

name	type	default	description
GET: https://api.constantcontact.com/v2/emailmarketing/campaigns/{campaignId}/tracking/unsubscribes
Test API
api_key	query		REQUIRED; The API key for the application
campaignId	path		Specifies the campaign to retrieve unsubscribe tracking data for
created_since	query		Use to retrieve only the contacts who unsubsribed from the email campaign on or after the date/time specified in ISO-8601 format.
limit	query	500	Specifies the number of results displayed per page of output, from 1 - 500, default = 500. See Paginated Output for more information on using `limit`.

Response CodesTOP

code	description
200	Request was successful
401	Authentication failure
404	Campaign ID not found
406	Unsupported accept header value, must be application/json
500	Internal server error occurred

StructureTOP

property	type(max length)	description
activity_type	string	Campaign activity type, is always EMAIL_UNSUBSCRIBE
campaign_id	string	Unique ID of the email campaign
contact_id	string	Unique ID of the contact
email_address	string	Email address the campaign was sent to
unsubscribe_date	string	Date the email campaign was sent
unsubscribe_reason	string	Reason for unsubscription
unsubscribe_source	string	Source of the unsubscribe, ACTION_BY_CUSTOMER or ACTION_BY_OWNER

Example ResponseTOP

{
    "meta": {
        "pagination": {
			"next_link": "/v2/emailmarketing/campaigns/1100394165287/tracking/unsubscribes?next=c3RhcnRBdD0zJmxpbWl0PTI"
		}
    },
    "results": [
        {
            "activity_type": "EMAIL_UNSUBSCRIBE",
            "campaign_id": "1100394165287",
            "contact_id": "23",
            "email_address": "abc@example.com",
            "unsubscribe_date": "2012-12-06T13:06:17.703Z",
            "unsubscribe_source": "ACTION_BY_CUSTOMER",
            "unsubscribe_reason": ""
        },
        {
            "activity_type": "EMAIL_UNSUBSCRIBE",
            "campaign_id": "1100394165287",
            "contact_id": "22",
            "email_address": "def@example.com",
            "unsubscribe_date": "2012-12-06T13:06:17.585Z",
            "unsubscribe_source": "ACTION_BY_CUSTOMER",
            "unsubscribe_reason": ""
        }
    ]
}