Chat icon

Chat

Interact with the Chat API

Actions253

Contact → Update

AI-generated

Summary

Update an existing contact with selected fields and attributes.

Inputs

  • accountId (required) — Select the account to use.
  • contactId (required) — Select the contact to use
  • name — Name of the contact
  • phoneNumber — Phone number of the contact in E.164 format (e.g., +5511999999999)
  • email — Email of the contact
  • specifyCustomAttributesUpdate — Specify how to update custom attributes
  • customAttributesDefinitionUpdate — Select custom attribute definitions to modify
  • customAttributesParametersUpdate — Select custom attribute parameters to modify
  • customAttributesJsonUpdate — Custom attributes in JSON format
  • additionalFields — Additional fields for the contact
  • identifier — A unique identifier for the contact in an external system
  • socialProfiles — Social media profiles of the contact

Output shape

a single updated contact record

Returns the updated contact object; behavior may include optional fields or error envelope depending on implementation.

Examples

Example 1: Update a contact's name and phone number

accountId selected, contactId selected, name set to "John Doe", phoneNumber set to "+5511999999999", other fields left unchanged

Example 2: Update custom attributes using keypair

accountId selected, contactId selected, specifyCustomAttributesUpdate set to "keypair", customAttributesParametersUpdate added key "department" with value "Sales", customAttributesJsonUpdate left default

Example 3: Update additional fields and social profiles

accountId selected, contactId selected, additionalFields set to avatarUrl "https://example.com/avatar.jpg" and blocked true, socialProfiles added LinkedIn URL

Links

Discussion