Use this endpoint to retrieve (GET), update (PUT), or optout/unsubscribe (DELETE) a contact. To create a new contact, use the POST method for the contacts-collection API.
Click a method to view its documentation
Privileges required: contacts:read
GET the contact specified by the contactId
path parameter.
GET: https://api.constantcontact.com/v2/contacts/{contactId} |
|||
name |
type |
default |
description |
---|---|---|---|
api_key |
query |
REQUIRED; The API key for the application |
|
contactId |
path |
ID of the contact being retrieved |
code |
description |
---|---|
200 |
Request was successful |
401 |
Authentication failure |
404 |
No persons found using 'contact ids (contact_id_you_entered)' |
406 |
Unsupported Accept Header value, must be application/json |
500 |
Internal server error occurred |
property |
type(max length) |
description |
||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+ addresses |
array |
Mail addresses for the contact. API currently supports a maximum of 2 addresses, 1 PERSONAL and 1 BUSINESS. It is possible to create up to 10 physical addresses using the product GUI. The API ignores any additional PERSONAL and BUSINESS addresses, and it ignores any other address_type. |
||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
cell_phone |
string (50) |
The contact's cell phone number |
||||||||||||||||||||||||||||||
company_name |
string (50) |
The contact's company |
||||||||||||||||||||||||||||||
confirmed |
boolean |
Confirmed = true if the contact has confirmed their email subscription, and it is false if they have not. |
||||||||||||||||||||||||||||||
created_date |
string |
Date & time the contact was added, in ISO 8601 format |
||||||||||||||||||||||||||||||
+ custom_fields |
array |
You can create up to 15 custom fields associated with a contact. The API currently only supports the custom field format described here. If the account uses the new contact management system, it is possible to create custom fields with varying formats. The API ignores custom fields not using the format below. |
||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
+ email_addresses |
array |
Array of contact's email addresses, Currently only one email address is supported for each contact. If the account uses the new contact management system, it is possible to create more than 1 email address per contact using the product GUI. The API ignores additional email addresses. |
||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
fax |
string (50) |
The contact's fax number |
||||||||||||||||||||||||||||||
first_name |
string (50) |
The contact's first name |
||||||||||||||||||||||||||||||
home_phone |
string (50) |
The contact's home phone number |
||||||||||||||||||||||||||||||
id |
string |
Unique ID for the contact |
||||||||||||||||||||||||||||||
job_title |
string (50) |
The contact's job title |
||||||||||||||||||||||||||||||
last_name |
string (50) |
The contact's last name |
||||||||||||||||||||||||||||||
+ lists |
array |
Array of the contact lists that the contact is a member of |
||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
modified_date |
string |
Date & time the contact was last updated, in ISO 8601 format; value is the same as |
||||||||||||||||||||||||||||||
+ notes |
array |
A note associated with the contact. |
||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
prefix_name |
string (4) |
Salutation (Mr., Ms., Sir, Mrs., Dr., etc) |
||||||||||||||||||||||||||||||
source |
string (50) |
Describes how the contact was added, from an application, web page, etc. |
||||||||||||||||||||||||||||||
source_details |
string (255) |
Name of the application that added the contact, if contact was added using the API |
||||||||||||||||||||||||||||||
status |
string |
Contact status, valid values are:
|
||||||||||||||||||||||||||||||
work_phone |
string (50) |
The contact's Work phone number |
{ "id": "196", "status": "ACTIVE", "fax": "318-978-7575", "addresses": [ { "id":"2", "line1": "47 Shawmut Ave.", "line2": "Suite 404", "city": "Boston", "address_type": "BUSINESS", "state":"Massachusetts", "state_code": "MA", "country_code": "us", "postal_code": "02158", "sub_postal_code": "" } ], "notes": [], "confirmed": false, "lists": [ { "id": "1", "status": "ACTIVE" } ], "source": "API", "email_addresses": [ { "id":"1", "status": "ACTIVE", "confirm_status": "NO_CONFIRMATION_REQUIRED", "opt_in_source": "ACTION_BY_VISITOR", "opt_in_date": "2013-01-23T13:48:44.108Z", "opt_out_date": "1969-12-31T19:00:00.000Z", "email_address": "rmartone@systems.com" } ], "prefix_name": "Mr.", "first_name": "Ronald", "last_name": "Martone", "job_title": "Systems Analyst 3", "company_name": "System Optimzations", "home_phone": "617-555-1212", "work_phone": "318-978-8896", "cell_phone": "448-989-3182", "custom_fields": [], "source_details": "Server Flow App" }