Our v3 API is now available! Learn more by visiting the v3 developer portal. Creating new v2 API keys is no longer supported.

Individual Email Campaign Schedule Endpoint

Use this endpoint to retrieve (GET), modify (PUT) or delete (DELETE) an existing email campaign schedule. To create a new campaign schedule use the POST method for the campaign schedule collection API.

Methods:

Click a method to view its documentation

GET PUT DELETE

DescriptionTOP

Retrieve a specific partner webhook topic by specifying the topicId path parameter. See the available topic ID's here.

DescriptionTOP

Privileges required: campaign:read

Retrieves the email campaign message specified by the campaignId path parameter. The tracking_summary data is current as of the last scheduled update, unless you set updateSummary=true to return updated data.

NOTE: Details of a deleted campaign cannot be retrieved. If a call is made to GET a deleted campaign by its ID, the call will fail and return a 404 Not Found response. You can login to the account to restore the campaign and then retrieve its details.

DescriptionTOP

Privileges required: contacts:lists:read

GET a specific contact list (specified using the listId path parameter).

DescriptionTOP

Privileges required: mylibrary:folder:read

Retrieve a specific MyLibrary folder using the folderId path parameter. 

DescriptionTOP

Privileges required: mylibrary:file:read

Retrieve a MyLibrary file using the fileId path parameter.

DescriptionTOP

Privileges required: campaign:read

Retrieve an event item by using the eventId and itemId path parameters to specify the event and item. 

DescriptionTOP

Privileges required: campaign:read

Get a specific event object (specified by the event_id path parameter). Properties with a null value are not returned in the JSON response.

DescriptionTOP

Privileges required: campaign:read

Retrieve detailed information about a specific registrant (specified by registrantId) for an event (specified by eventId).

DescriptionTOP

Privileges required: campaign:read

Retrieve a specific promotional code for an event; use the promocodeId and eventId path parameters to specify the code and the event it belongs to.

DescriptionTOP

Privileges required: campaign:read

Retrieve a specific fee for an event, specified using the eventId and feeId path parameters.

GET: https://api.constantcontact.com/v2/emailmarketing/campaigns/{campaignId}/schedules/{scheduleId}

Test API

name

type

default

description

api_key

query

REQUIRED; The API key for the application

campaignId

path

Specifies the email campaign to retrieve the schedule for

scheduleId

path

Specifies the schedule to retrieve

Response CodesTOP

code

description

200

Request was successful

401

Authentication failure

404

Campaign Schedule not found for id

406

Unsupported Accept Header value, must be application/json

500

Internal server error occurred

StructureTOP

property

type(max length)

description

Example ResponseTOP

{ 
    "id" : "1", 
    "scheduled_date" : "2013-05-10T11:07:43.626Z" 
}