Create a new contact

POST

https://api.close.com/api/v1/contact/

POST

/api/v1/contact/

$ curl -X POST https://api.close.com/api/v1/contact/ \
>      -H "Content-Type: application/json" \
>      -u "<CLOSE_API_KEY>:" \
>      -d '{
>   "emails": [
>     {
>       "email": "john@example.com",
>       "type": "office"
>     }
>   ],
>   "lead_id": "lead_QyNaWw4fdSwxl5Mc5daMFf3Y27PpIcH0awPbC9l7uyo",
>   "name": "John Smith",
>   "phones": [
>     {
>       "phone": "9045551234",
>       "type": "mobile"
>     }
>   ],
>   "title": "President",
>   "urls": [
>     {
>       "url": "http://twitter.com/google/",
>       "type": "url"
>     }
>   ],
>   "custom.cf_j0P7kHmgFTZZnYBFtyPSZ3uQw4dpW8xKcW7Krps8atj": "Account Executive"
> }'

1 {
2   "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
3   "date_created": "2013-03-07T23:23:21.495000+00:00",
4   "date_updated": "2013-03-07T23:23:21.495000+00:00",
5   "display_name": "John Smith",
6   "id": "cont_sNIdBgngvbdTTEN1mspKgUqKAWfbul4IITvnWoRw1T7",
7   "name": "John Smith",
8   "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
9   "title": "President",
10   "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
11   "emails": [
12     {
13       "email": "john@example.com",
14       "is_unsubscribed": false,
15       "type": "office"
16     }
17   ],
18   "phones": [
19     {
20       "phone": "+19045551234",
21       "type": "mobile",
22       "country": "US",
23       "phone_formatted": "+1 904-555-1234"
24     }
25   ],
26   "urls": [
27     {
28       "type": "url",
29       "url": "http://twitter.com/google/"
30     }
31   ],
32   "custom.cf_j0P7kHmgFTZZnYBFtyPSZ3uQw4dpW8xKcW7Krps8atj": "Account Executive"
33 }

Contacts belong to exactly one Lead (specified by lead_id). If you do not provide a lead_id then a new lead will be created, named after the contact.

Custom field values can be set by including custom.cf_* keys in the request body, e.g. "custom.cf_abc123": "value".

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

_fieldsstringOptional

Comma-separated list of fields to include in the response.

Request

This endpoint expects an object.

created_bystring or nullOptional

date_createddatetime or nullOptional

emailslist of objects or nullOptional

lead_idstring or nullOptional

namestring or nullOptional<=1000 characters

phoneslist of objects or nullOptional

timezonestring or nullOptional

IANA timezone identifier

titlestring or nullOptional<=1000 characters

urlslist of objects or nullOptional

Response

Successful response

created_bystring or null

date_createddatetime

date_updateddatetime

display_namestring

idstring

namestring or null

organization_idstring

titlestring or null

updated_bystring or null

emailslist of objects

integration_linkslist of objects

lead_idstring or null

lead_suggestions_operation_idstring or null

phoneslist of objects

recent_callslist of objects

subscriptionslist of objects

timezonestring or null

timezone_sourcestring or null

urlslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error