Our v3 API is now available! Learn more by visiting the v3 developer portal.

Individual Contact List

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.

Methods:

Click a method to view its documentation

GET PUT DELETE

DescriptionTOP

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.

PUT: https://api.constantcontact.com/v2/lists/{listId}

Test API

name

type

default

description

api_key

query

REQUIRED; The API key for the application

listId

path

Specifies the contact list to modify

Example JSON Request BodyTOP

	{
		"name": "Usefull Tips & Tricks!",
		"status": "ACTIVE"
	}

Response CodesTOP

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

StructureTOP

property

type(max length)

description

contact_count

integer

The number of contacts in the list (Read Only)

created_date

string

Time stamp indicating when the contact list was created, in ISO-8601 format (Read Only)

id

string

Unique ID for each contact list (Read Only)

list_id

string

The uuid formatted unique identifier used to identify the list in the V3 API. Useful for migrating V2 API integrations to the V3 API. (Read Only)

modified_date

string

Time stamp indicating when the contact list was last modified, in ISO-8601 format (Read Only)

name

string (255)

REQUIRED. Contact list name

status

string

REQUIRED. The contact list status, valid values are:

  • ACTIVE - the list is visible to contacts to join, and visible to Constant Contact users
  • HIDDEN - list is not visible to contacts, but it is visible to Constant Contact users

Example ResponseTOP

{
    "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
}