Use this endpoint to retrieve (GET) an existing schedule or create (POST) a new schedule for an email campaign.
Click a method to view its documentation
Privileges required: campaign:list
Retrieves the email campaigns in a user's account as follows:
status
query parameter; see the parameter table below for status types and definitionsmodified_since
query parameter. This is useful for syncing email campaigns across applications.Campaign sort order depends on the campaign status:
Status | Campaign sort order |
DRAFT | by the latest modified_date |
SENT | by the latest last_run_date |
SCHEDULED | by the next_run_date |
DELETED | by the latest last_run_date if it was sent, or by the latest modified_date, if it was never sent |
Deleted campaigns are included in a GET response only when status=DELETED query parameter is used. They are not included in the GET collection by default. You cannot retrieve an individual deleted campaign object using the API.
Privileges required: mylibrary:file:read
Retrieve a list of MyLibrary folders and their properties for the authorized Constant Contact account. MyLibrary supports a folder hierarchy with 3 levels of nesting. Primary, child (2nd level) and grandchild (3rd level) folders all have the same properties associated with them. This endpoint returns an empty results array if there are no folders in the user's account.
Privileges required: mylibrary:file:read
The following options are available when retrieving Library files:
api_key
)type
query parameter (ALL, IMAGE, or Document)source
query parametertype
and source
query parametersThere are many options available for sorting the JSON response using the sort_by
query parameter.
Privileges required: campaign:read
Retrieve a list of all items for an event specified using the eventId
path parameter.
Privileges required: campaign:read
Retrieve the collection of all registrants for the event specified using the event_id
path parameter.
Privileges required: campaign:read
Retrieve all promocodes for an event specified by the eventId
path parameter.
Privileges required: campaign:read
Retrieve all fees for the event specified by the event_id
path parameter.
Privileges required: campaign:read
Retrieve all attributes for an event item. Specify the event and item using the eventId
and itemId
path parameters.
Privileges required: campaign:read
Retrieve the email campaign schedule specified by the campaignId
and scheduleId
path parameters.
NOTE: Only email campaigns with a SCHEDULED status have a schedule associated with them.
GET: https://api.constantcontact.com/v2/emailmarketing/campaigns/{campaignId}/schedules |
|||
name |
type |
default |
description |
---|---|---|---|
api_key |
query |
REQUIRED; The API key for the application |
|
campaignId |
path |
Specifies the email campaign for which to retrieve the schedule |
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 |
property |
type(max length) |
description |
---|
[ { "id" : "1", "scheduled_date" : "2013-05-10T11:07:43.626Z" } ]