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
Description TOP
Privileges required : contacts:lists:write
PUT: Update the name, status of the ContactList specified by the
listId
path parameter. Performing a PUT overwrites all existing properties for the contactlist resource; any properties left blank or not included in the call will delete those property values prior to the call.
Description TOP
Privileges required : mylibrary:folder:update
Use PUT to modify the following properties for a folder specified by
folderId
path parameter:
-
update the folder's
name -
change the folder's location in the directory structure by changing it's
parent_id
To move a folder to level 1 in the directory structure, set theparent_idto 0
Description TOP
Privileges required : mylibrary:file:update
Use a PUT call to update the following for a file (specified using the
fileId
path parameter):
-
Update the
name - Update the description
-
Move a file to another folder, using
folder_idto specify the destination folder.
Description TOP
Privileges required : campaign:write
Update an existing event by using the
eventId
path parameter.
Description TOP
Privileges required : campaign:write
Update an existing event item; specify the event and the item using the
eventId
and
itemId
path parameters.
Description TOP
Privileges required : campaign:write
Update an existing promocode for an event; specify the code and event using the
eventId
and
promocodeId
path parameters.
Description TOP
Privileges required : campaign:write
Update an existing fee (specify using
feeId
) for an event specified by
eventId
.
Description TOP
Privileges required : campaign:write
Update an existing item attribute by specifying the
eventId
,
itemId
, and
attributeId
path parameters. Include the attribute name and description in the JSON request body.
NOTE: You cannot change an attribute name once any have been sold to or claimed by event registrants.
Description TOP
Privileges required : campaign:activate
Update the schedule for an email campaign using the
scheduleId
and
campaignId
path parameters.
Description TOP
Privileges required : campaign:create
Update an existing email campaign message specified by the
campaignId
path parameter. For campaigns with a template_type = CUSTOM, all editable fields are available for updating. If template_type = STOCK, the following fields are not available for edit (read-only):
- text_content
- email_content
- style_sheet
These fields can only be updated using the Constant Contact user interface.
NOTE: There are several campaign properties that are optional by default, but become REQUIRED once another property is used. See Structure table below for specific properties.
|
PUT: https://api.constantcontact.com/v2/emailmarketing/campaigns/{campaignId}/schedules/{scheduleId} |
|||
Example JSON Request Body TOP
{
"scheduled_date" : "2013-05-10T11:07:43.626Z"
}
Response Codes TOP
|
code |
description |
|---|---|
|
200 |
Request was successful. |
|
400 |
Either JSON was malformed or there was a data validation error |
|
401 |
Authentication failure |
|
404 |
Campaign Schedule not found for id |
|
406 |
Unsupported Accept Header value, must be application/json |
|
415 |
Unsupported content-type in the header, use application/json |
|
500 |
Internal server error occurred |
Structure TOP
|
property |
type (max length) |
description |
|---|
Example Response TOP
{
"id" : "1",
"scheduled_date" : "2013-05-10T11:07:43.626Z"
}