⚠️ 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.
Custom message associated with the inbound DND setting
Example:Please do not contact me via this channel
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
anyOf
TextField
LargeTextField
SingleSelectField
RadioField
NumericField
MonetoryField
CheckboxField
MultiSelectField
FileField
customFields[].idstringrequired
Pass either id or key of custom field
Example:6dvNaf7VhkQ9snc5vnjJ
customFields[].keystring
Pass either id or key of custom field
Example:my_custom_field
customFields[].fieldValuestring
Text value for the custom field (preferred).
Example:My Text
customFields[].field_valuestringdeprecated
Deprecated. Use fieldValue instead.
Example:My Text
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.
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.
⚠️ 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.
Date and time the contact was last updated (ISO 8601)
Example:2021-07-02T05:18:26.704Z
contact.attachmentsstring[]deprecated
Deprecated: leftover field, not populated. Contact files are stored as documents on the contact, not here, so this is empty or absent (older records may still carry stale values).
Example:[]
contact.ssnstring
Social Security Number (if applicable)
Example:123-45-6789
contact.keywordstring
Search keyword associated with the contact
Example:test
contact.firstNameLowerCasestring
Lowercase version of the contact first name
Example:rubika
contact.fullNameLowerCasestring
Lowercase version of the contact full name
Example:rubika deo
contact.lastNameLowerCasestring
Lowercase version of the contact last name
Example:deo
contact.lastActivitystring
Date and time of last activity on this contact (ISO 8601)
Example:2021-07-16T11:39:30.564Z
contact.customFieldsobject[]
List of custom field values for the contact
contact.customFields[].idstring
Unique identifier of the custom field
Example:MgobCB14YMVKuE4Ka8p1
contact.customFields[].valuestring
Value of the custom field
Example:name
contact.businessIdstring
Business Id the contact is associated with
Example:641c094001436dbc2081e642
contact.attributionSourceobject
First-touch attribution source details for the contact