Constant Contact API Quick Reference
The tables below list the relative URIs for specific APIs. To make an actual call, append the relative URI to:
https://api.constantcontact.com/ws/customers/{username}. To learn how to authenticate API calls, click here. For a list of common error codes, click here.
|
CONTACTS
|
|
Used to create, update, delete and manage contacts for an account
|
|
URI
|
Description
|
Supported
Operations
|
|
/contacts
|
The contacts resource holds all contacts for the {username} account.
GET – retrieve all contacts for the account
POST – add a new contact to the account
|
GET, POST
|
|
/contacts/{contact-id}
|
The entry for a given contact identified by {contact-id}.
GET – retrieve the entry for the contact
PUT - change information for a contact, including contact list membership.
DELETE - opt-out the contact from all lists.
|
GET, PUT, DELETE
|
|
/contacts?email={email-address}
|
Search for a specific contact by email address.
|
GET
|
|
/contacts?updatedsince={date}&listtype={list-type}
|
Search for contacts on specific list types that have been updated since a specified date. The supported list types are active, removed and do-not-mail.
|
GET
|
|
/contacts?updatedsince={date}&listid={numeric-list-id}
|
Search for contacts on a specific list that have been updated since a specified date.
|
GET
|
|
LISTS
|
|
Used to create, update and delete mailing lists
|
|
URI
|
Description
|
Supported
Operations
|
|
/lists
|
The contact lists resource containing all contact lists for the {username} account.
GET – retrieve the list of all mailing lists for the account
POST – create a new mailing list
|
GET, POST
|
|
/lists/{list-id}
|
The entry for a given contact list identified by {list-id}.
GET – retrieve the entry for the list identified by {list-id}
PUT – update the list identified by {list-id}
DELETE – delete the list identified by {list-id}. Will return a 204 (No Content) if successful
|
GET, PUT, DELETE
|
|
/lists/{list-id}/members
|
The members resource for a given contact list identified by {list-id}.
|
GET
|
|
/contacts/{contact-id}
|
Contact list membership is controlled by the contact entry.
GET – retrieves the contact entry including list association
PUT - used to change list association for a contact.
DELETE - opt-out the contact from all lists.
|
GET, PUT, DELETE
|
|
CAMPAIGNS
|
|
Used to create and manage email marketing campaigns
|
|
URI
|
Description
|
Supported
Operations
|
|
/campaigns
|
The campaign resource containing all campaigns for the {username} account.
GET - list all campaigns.
POST - create a new campaign.
|
GET, POST
|
|
/campaigns/{campaign-id}
|
The entry for a given campaign identified by {campaign-id}.
GET - return details for the specified campaign
PUT - update selected information for the specified campaign.
|
GET, PUT
|
|
/campaigns?status=<status>
|
Search for campaigns with a given status. Allowed status values are DRAFT, RUNNING, SENT and SCHEDULED. Returns a entry with the campaigns that satisfy the search criteria.
|
GET
|
|
/campaigns/{campaign-id}/events/
|
The campaign events resource that contains send, open, unsubscribe, click, bounce and forward events for a given campaign. Note that the trailing ‘/’ is required for the GET.
|
GET
|
|
/contacts/{contact-id}/events/
|
The per-contact campaign events resource contains send, open, unsubscribe, click, bounce and forward events for a given contact. Data for the last 90 days is maintained in this resource for each contact in an account.
|
GET
|
|
EVENTS
|
|
Used to create and manage event marketing events, registrants and guests
|
|
URI
|
Description
|
Supported
Operations
|
|
/events
|
The events resource containing all events for the {username} account.
GET – retrieve a list of all events.
POST - create a new event marketing event.
|
GET, POST
|
|
/events/{event-id}
|
The entry for a given event marketing event identified by {event-id}.
GET – retrieve details for the specified event.
PUT - update selected information for the specified event.
|
GET, PUT
|
|
/events/{event-id}/registrants
|
The registrants resource for the event specified by {event-id}.
GET - retrieve the list of registrants for the event.
|
GET
|
|
/events/{event-id}/registrants/{registrant-id}
|
The registrant information for a particular registrant identified by {registrant-id} for the event identified by {event-id}.
|
GET
|
|
/events/{event-id}/registrants/{registrant-id}/guests
|
The guest list for a particular registrant identified by {registrant-id} for the event identified by {event-id}.
|
GET
|
|
/events/{event-id}/registrants/{registrant-id}/guests/{guest-id}
|
The guest entry for a guest identified by {guest-id} for a particular registrant identified by {registrant-id} for the event identified by {event-id}..
|
GET
|
|
/events/{event-id}/registrants/{registrant-id}/attendancestatus
|
The attendance status for a particular registrant identified by {registrant-id} for the event identified by {event-id}.
GET - retrieve the attendance status for the registrant.
PUT - updates the attendance status for the registrant.
|
GET, PUT
|
|
/events/{event-id}/registrants/{registrant-id}/paymentstatus
|
The payment status for a particular registrant identified by {registrant-id} for the event identified by {event-id}.
GET - retrieve the payment status for the registrant.
PUT - updates the payment status for the registrant.
|
GET, PUT
|
ACTIVITIES
|
|
Used to perform bulk contact uploads and exports
|
|
URI
|
Description
|
Supported
Operations
|
|
/activities
|
The activities resource that contains all activities for the {username} account.
GET – retrieve all activities
POST – create a new activity
|
GET, POST
|
|
/activities/{activity-id}
|
The entry for the activity identified by {activity-id}
|
GET
|
|
|
|
|
