Skip to main content
ContactsVersion: v3New

Update Contact

PUT/contacts/{contactId}

Update a contact using contactId

⚠️ When updating additional emails/phones, always include the current primary email/phone in the same request. Otherwise, the existing primary value may be lost.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:contacts.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

contactIdstringrequired

Unique identifier of the contact

Example:ve9EPM428h8vShlRW1KT

Body

firstNamestringnullable

First name of the contact

Example:rosan
lastNamestringnullable

Last name of the contact

Example:Deo
namestringnullable

Full name of the contact

Example:rosan Deo
emailstringnullable

Email address of the contact

phonestringnullable

Phone number of the contact

Example:+1 888-888-8888
address1stringnullable

Street address of the contact

Example:3535 1st St N
citystringnullable

City of the contact

Example:Dolomite
statestringnullable

State of the contact

Example:AL
postalCodestring

Postal code of the contact

Example:35061
websitestringnullable

Website URL of the contact

Example:https://www.tesla.com
timezonestringnullable

Timezone of the contact

Example:America/Chihuahua
dndboolean

Whether Do Not Disturb is enabled for the contact

Example:true
inboundDndSettingsobject

Inbound DND settings per channel for the contact

tagsstring[]

This field will overwrite all current tags associated with the contact. To update a tags, it is recommended to use the Add Tag or Remove Tag API instead.

Example:["nisi sint commodo amet","consequat"]
customFieldsobject[]

List of custom field values to assign to the contact

sourcestringnullable

Source from which the contact was updated

Example:public api
dateOfBirthstringnullable

The birth date of the contact. Supported formats: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD, MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY, YYYY_MM_DD, MM_DD_YYYY

Example:1990-09-25
countrystring

Country code of the contact (ISO 3166-1 alpha-2), Refer country list from documentaion, documentation has list of all countries

Example:US
assignedTostringnullable

User's Id

Example:y0BeYjuRIlDwsDcOHOJo
additionalEmailsobject[]

Add additional email addresses to a contact.

⚠️ Important: When sending additionalEmails, you must also include the contact’s current primary email in the same request.
If you send additionalEmails without email, the contact’s existing primary email may be cleared or replaced.

  • email represents the contact’s primary email address.
  • additionalEmails represents secondary email addresses for the same contact.
  • Always send the primary email together with additionalEmails when updating email addresses.
  • A maximum of 10 additional email addresses can be provided.

Example

{
"email": "[email protected]",
"additionalEmails": [
{
"email": "[email protected]"
}
]
}

Avoid

{
"additionalEmails": [
{
"email": "[email protected]"
}
]
}

Sending only additionalEmails may cause the existing primary email to be lost.

If email uniqueness is enabled for the location, every email address in the request—primary and additional—must be unique across contacts. If any email already belongs to another contact, the request fails with 400 Bad Request and no changes are saved.

Possible values: <= 10

additionalPhonesobject[]

Add additional phone numbers to a contact.

⚠️ Important: When sending additionalPhones, you must also include the contact’s current primary phone in the same request.
If you send additionalPhones without phone, the contact’s existing primary phone may be cleared or replaced.

  • phone represents the contact’s primary phone number.
  • additionalPhones represents secondary phone numbers for the same contact.
  • Always send the primary phone together with additionalPhones when updating phone numbers.
  • A maximum of 10 additional phone numbers can be provided.
  • phoneLabel is optional. Allowed values: Home, Work, Mobile, or Landline. A label can belong to only one phone number on the contact, including the primary. If a label is repeated, it is kept on the first phone number and removed from the others.

Example

{
"phone": "+14155550100",
"additionalPhones": [
{
"phone": "+14155550101",
"phoneLabel": "Work"
}
]
}

Avoid

{
"additionalPhones": [
{
"phone": "+14155550101",
"phoneLabel": "Work"
}
]
}

Sending only additionalPhones may cause the existing primary phone number to be lost.

If phone uniqueness is enabled for the location, every phone number in the request—primary and additional—must be unique across contacts. If any phone number already belongs to another contact, the request fails with 400 Bad Request and no changes are saved.

Possible values: <= 10

dndSettingsobject

Per-channel DND settings for the contact

Response

Successful response

succeededboolean

Whether the update operation succeeded

Example:true
contactobject

Contact details