Update Contact
Getting Started
Update Contact
Change the attributes of an existing contact. Values are overwritten unless a row sends replace: false. Fails with 404 if the number is not a contact.
POST
Update Contact
Changes the attributes of a contact that is already in your CRM, for example when a lead’s status changes in your own system.
Quick Example
Use Cases
- Status changes: update a lead stage or payment status when it changes in your CRM or billing system
- Enrichment: fill in details you learn later, such as city, company or plan
- Keeping two systems in step: copy changes from your own database so agents and workflows see current values
Where to find the values
How attributes are saved
Each row inattributes is a key, a value and an optional replace.
replace: true(the default here) overwrites the value the contact already has.replace: falseonly fills an attribute that is empty. An existing value is kept and listed underkept_existing.- Edits made by hand win: a value someone typed into the CRM is never overwritten through the API, even with
replace: true. It is listed underkept_existing. - Matching names:
keyis matched ignoring case, spaces, underscores and hyphens, so"First Name"matchesfirst_name. - Types: the value is checked against the attribute’s type. A number attribute needs a number, a date needs a date, and an enum value must be one of its options.
- Leaving a value out changes nothing: attributes you do not send keep their values, and a blank value is skipped rather than clearing the attribute.
Errors worth handling
404 Contact not found
404 Contact not found
The number is not a contact on the account this key belongs to. Create it with Create Contact, or check the number and the key.
401 Invalid API key
401 Invalid API key
The
X-API-KEY header is missing or does not belong to any account.403 Account is inactive
403 Account is inactive
The account the key belongs to has been deactivated. Contact support.
400 Missing to_number, or a problem with attributes
400 Missing to_number, or a problem with attributes
The body has no phone number,
attributes is not a list, or a row has no key, a non-boolean replace, an object or list as its value, or a value longer than 1000 characters.Authorizations
API key from https://callkaro.ai/dashboard/api-key
Body
application/json
Phone number with country code. A 10-digit number is read as Indian (+91). Spaces, dashes and + are ignored.
Example:
"+919876543210"
CRM attributes to save on the contact. Only attributes that already exist in CRM > Attributes are saved.
Maximum array length:
50