/contacts [deprecated]

Creates a contact, or several when you pass them in a contacts array. Each contact is matched by email among your own contacts: if one exists, it is updated instead of duplicated. Emails are stored in lowercase.

On an existing contact, name is replaced only when you pass a non-empty one, meta is merged into the existing meta, and groups replaces the contact's group list.

A meta key named cc (any case) is dropped. Names longer than 100 characters, or that look like an email address, are not saved.

A single contact returns the contact. A contacts array returns { "contacts": [...] } in the order you sent them; an entry that could not be saved (for example an email that does not look like a person, such as noreply@...) comes back as an object without _id.

This operation is deprecated. It has no replacement in the public API, and no removal date has been announced.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Comma-separated, same values as on GET /contacts except groups. Defaults to salesforce,pipedrive. Pass an empty value to skip the expansion.

Body Params
string
required

Email address, up to 500 characters. Your existing contact with this email is updated.

string

Name, up to 500 characters. Names over 100 characters are not saved.

groups
array of strings

Ids of contact groups to put the contact in. Replaces the groups it is already in.

groups
meta
object

Variables for templates and sequences. Merged into the existing meta.

string

Id of the matching Google contact.

string

Id of the matching Salesforce contact or lead.

boolean
Defaults to false

true to add one to usedCount and set timestamp to now.

boolean
Defaults to false

true to queue a sync to Google Contacts for contacts not yet synced.

Responses

500

The contacts could not be saved. The response has no body.

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
Psst... like working with APIs? Come join us!