Sign in
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"}
{"stackTrail":"paths:/v1/contacts/{contactId}:put:requestBody:content:application/json:schema:properties:first_met_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

Response

Successful response

errorboolean required

Changes

Changed in 6 of the 17 revisions of this API.197

  • a2f71a2438392See the full diff
    • ○

      api operation id updateContactV1 was added

      api-operation-id-added

    • ○

      added the non-success response with the status 409

      response-non-success-status-added

  • b387e63b4b908See the full diff
    • ●

      the contact_emails/items/email request property's maxLength was set to 320

      request-property-max-length-set

    • ●

      the contact_phone_numbers/items/phone_number request property's maxLength was set to 50

      request-property-max-length-set

    • ●

      the contact_phone_numbers/items/phone_number_sanitized/anyOf[subschema #1]/ request property's maxLength was set to 50

      request-property-max-length-set

    • ●

      the linkedin_last_message_snippet/anyOf[subschema #1]/ request property's maxLength was set to 500

      request-property-max-length-set

    • ●

      the coordinates/data/latitude request property's max was set to 90.00

      request-property-max-set

    • ●

      the coordinates/data/longitude request property's max was set to 180.00

      request-property-max-set

    • ●

      the coordinates/data/latitude request property's min was set to -90.00

      request-property-min-set

    • ●

      the coordinates/data/longitude request property's min was set to -180.00

      request-property-min-set

  • 553c90fb89591See the full diff
    • ○

      added the optional property data/contact/first_interaction_at to the response with the 200 status

      response-optional-property-added

  • 6f01cd52ac1212See the full diff
    • ●

      removed the request property created_at

      request-property-removed

    • ○

      added the new optional request property first_met_at

      new-optional-request-property

    • ○

      added the optional property data/contact/first_met_at to the response with the 200 status

      response-optional-property-added

  • bb07f694354611See the full diff
    • ▲

      removed subschema #1 subschema #2 from the related_contacts/anyOf[subschema #1]/remove/items/ request property anyOf list

      request-property-any-of-removed

    • ○

      added subschema #1 subschema #2 to the related_contacts/anyOf[subschema #1]/remove/items/ request property anyOf list

      request-property-any-of-added

  • 07a79f0ff8791See the full diff
    • ○

      added the new optional request property created_at

      new-optional-request-property