contacts
Update a contact
Update a single contact by its ID. Only the fields included in the request body are modified; omitted fields remain unchanged.
put/v1/contacts/{contactId}
Path parameters
contactIdstring uuid required
Request body
full_namestring
first_namestring
last_namestring
descriptionstring
job_titlestring
legacy_locationstring
companystring
educationstring
starredboolean
source'linkedin_sync' | 'facebook_import' | 'cal_ingest' | 'email_ingest' | 'web_import' | 'csv_import' | 'whatsapp_sync' | 'imessage_sync' | 'phone_calls_sync' | 'mobile' | 'mobile_import' | 'instagram_sync' | 'oauth_interaction'
priority_tierinteger
image_urlstring uri
image_sourcestring uri
business_card_urlstring uri
{"stackTrail":"paths:/v1/contacts/{contactId}:put:requestBody:content:application/json:schema:properties:website:anyOf","oasType":"schema","type":"unknown"}
birthdaystring date
birthday_yearnumber
frequencystring
{"stackTrail":"paths:/v1/contacts/{contactId}:put:requestBody:content:application/json:schema:properties:last_seen_at:anyOf","oasType":"schema","type":"unknown"}
never_keep_in_touchboolean
{"stackTrail":"paths:/v1/contacts/{contactId}:put:requestBody:content:application/json:schema:properties:next_reminder_at","oasType":"schema","type":"unknown"}
linkedinstring
twitterstring
facebookstring
instagramstring
telegramstring
tiktokstring
youtubestring
whatsapp_message_linkstring
whatsapp_message_snippetstring
{"stackTrail":"paths:/v1/contacts/{contactId}:put:requestBody:content:application/json:schema:properties:whatsapp_last_message_at:anyOf","oasType":"schema","type":"unknown"}
imessage_message_linkstring
imessage_message_snippetstring
{"stackTrail":"paths:/v1/contacts/{contactId}:put:requestBody:content:application/json:schema:properties:imessage_last_message_at:anyOf","oasType":"schema","type":"unknown"}
linkedin_message_linkstring
linkedin_last_message_snippetstring
{"stackTrail":"paths:/v1/contacts/{contactId}:put:requestBody:content:application/json:schema:properties:linkedin_last_message_at:anyOf","oasType":"schema","type":"unknown"}
linkedin_dataobject
instagram_message_linkstring
instagram_message_snippetstring
{"stackTrail":"paths:/v1/contacts/{contactId}:put:requestBody:content:application/json:schema:properties:instagram_last_message_at:anyOf","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/v1/contacts/{contactId}:put:requestBody:content:application/json:schema:properties:gmail_last_interaction_at:anyOf","oasType":"schema","type":"unknown"}
gmail_last_interaction_provider_idstring
gmail_last_interaction_subjectstring
gmail_last_interaction_provider'GOOGLE' | 'OFFICE365'
{"stackTrail":"paths:/v1/contacts/{contactId}:put:requestBody:content:application/json:schema:properties:gcal_last_interaction_at:anyOf","oasType":"schema","type":"unknown"}
gcal_last_interaction_provider_idstring
gcal_last_interaction_titlestring
gcal_last_interaction_provider'GOOGLE' | 'OFFICE365'
{"stackTrail":"paths:/v1/contacts/{contactId}:put:requestBody:content:application/json:schema:properties:phone_call_last_interaction_at:anyOf","oasType":"schema","type":"unknown"}
phone_call_interaction_snippetstring
web_search_summaryobject
is_archivedboolean
ignore_mergeboolean
{"stackTrail":"paths:/v1/contacts/{contactId}:put:requestBody:content:application/json:schema:properties:created_at","oasType":"schema","type":"unknown"}
Response
Successful response
errorboolean required