Skip to main content
PUT
cURL

Authorizations

X-API-KEY
string
header
required

Query Parameters

email
string

Email to look up. If a contact with this email exists it will be updated; otherwise a new contact is created. Provide only one of email, linkedin_url, or phone.

linkedin_url
string

LinkedIn URL to look up. If a contact with this LinkedIn URL exists it will be updated; otherwise a new contact is created. Provide only one of email, linkedin_url, or phone.

phone
string

Phone number (E.164) to look up. If a contact with this phone exists it will be updated; otherwise a new contact is created. Provide only one of email, linkedin_url, or phone.

structure
enum<string>
default:NESTED

Format of custom fields in response. NESTED returns array of objects with id, field_name, field_value. FLAT returns object with field names as keys.

Available options:
FLAT,
NESTED

Body

email
string | null
linkedin_url
string | null
phone
string | null
first_name
string
last_name
string
job_title
string | null
company_id
integer | null
contact_custom_fields_input
object[]
write-only
origin
string
contact_status
string
do_not_contact
string | null

Response

OK. The contact already existed and was updated.

id
integer
required
read-only
updated_time
string<date-time>
required
read-only
contact_custom_fields
string
required
read-only
first_campaign_email_sent
string<date-time>
required
read-only
last_campaign_email_sent
string<date-time>
required
read-only
last_reply_received
string<date-time>
required
read-only
previous_status
string | null
required
read-only
status_changed_at
string<date-time> | null
required
read-only
total_linkedin_messages_sent
integer
default:0
required
read-only
first_linkedin_message_sent
string<date-time>
required
read-only
last_linkedin_message_sent
string<date-time>
required
read-only
total_linkedin_message_replies
integer
default:0
required
read-only
last_linkedin_message_reply_received
string<date-time>
required
read-only
interested_linkedin_message_replies
integer
default:0
required
read-only
total_linkedin_inmails_sent
integer
default:0
required
read-only
first_linkedin_inmail_sent
string<date-time>
required
read-only
last_linkedin_inmail_sent
string<date-time>
required
read-only
total_linkedin_inmail_replies
integer
default:0
required
read-only
last_linkedin_inmail_reply_received
string<date-time>
required
read-only
interested_linkedin_inmail_replies
integer
default:0
required
read-only
total_linkedin_connection_requests_sent
integer
default:0
required
read-only
first_linkedin_connection_request_sent
string<date-time>
required
read-only
last_linkedin_connection_request_sent
string<date-time>
required
read-only
total_linkedin_connections_accepted
integer
default:0
required
read-only
first_linkedin_connection_accepted
string<date-time>
required
read-only
last_linkedin_connection_accepted
string<date-time>
required
read-only
email
string | null
linkedin_url
string | null
phone
string | null
first_name
string
last_name
string
job_title
string | null
company_id
integer | null
origin
string
contact_status
string
do_not_contact
string | null