Use this endpoint to retrieve (GET), update (PUT), or delete (DELETE) a contact list. To create a new contact list, use the POST method for the Contact List Collection.
Click a method to view its documentation
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.
Privileges required: mylibrary:folder:update
Use PUT to modify the following properties for a folder specified by folderId
path parameter:
name
parent_id
parent_id
to 0Privileges required: mylibrary:file:update
Use a PUT call to update the following for a file (specified using the fileId
path parameter):
name
folder_id
to specify the destination folder.
Privileges required: campaign:write
Update an existing event by using the eventId
path parameter.
Privileges required: campaign:write
Update an existing event item; specify the event and the item using the eventId
and itemId
path parameters.
Privileges required: campaign:write
Update an existing promocode for an event; specify the code and event using the eventId
and promocodeId
path parameters.
Privileges required: campaign:write
Update an existing fee (specify using feeId
) for an event specified by eventId
.
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.
Privileges required: campaign:activate
Update the schedule for an email campaign using the scheduleId
and campaignId
path parameters.
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):
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/lists/{listId} |
|||
name |
type |
default |
description |
---|---|---|---|
api_key |
query |
REQUIRED; The API key for the application |
|
listId |
path |
Specifies the contact list to modify |
{ "name": "Usefull Tips & Tricks!", "status": "ACTIVE" }
code |
description |
---|---|
200 |
Request was successful, contact list updated |
401 |
Authentication failure |
404 |
Contact list not found |
406 |
Unsupported accept header value, must be application/json |
415 |
Unsupported content-type in the header, use application/json |
500 |
Internal server error occurred |
property |
type(max length) |
description |
---|
{ "id": "4", "name": "Useful Tips & Tricks!", "status": "ACTIVE", "created_date": "2013-04-23T15:07:40.000Z", "modified_date": "2013-04-23T15:13:43.000Z", "contact_count": 390 }