Skip to content

Update Contact

Required scope: contact:write

Updates a contact by ID. This is a partial update: only the fields you send are changed. Omit a field to leave it unchanged; send an empty string to clear it. phone is normalized to E.164, using phoneCountry (ISO 3166-1 alpha-2) to resolve a local number.

Generated Reference
POST /public-api/publicapi.v1.Contact/UpdateContact

Updates a contact's editable fields. Only supplied fields change: omit a field to leave it unchanged, or send an empty string to clear it.

Request UpdateContactRequest
Response UpdateContactResponse

UpdateContactRequest

Field Type Description
id string Contact to update.
name optional string New display name. Omit to leave unchanged; send an empty string to clear.
email optional string New email address. Omit to leave unchanged; send an empty string to clear.
phone optional string New phone number in any common format; normalized to E.164 server-side. Omit to leave unchanged; send an empty string to clear.
phone_country optional string Two-letter ISO 3166-1 country code used to normalize a national phone number. Ignored when phone is already in E.164 format.
locale optional string New BCP 47 locale tag. Omit to leave unchanged; send an empty string to clear.

UpdateContactResponse

Field Type Description
contact Contact The contact after the update.
{
"id": "<contact-id>",
"email": "[email protected]"
}
{
"contact": {
"id": "<contact-id>",
"name": "Alex Jansen",
"email": "[email protected]",
"phoneE164": "+31612345678",
"customerNumber": "C-000123",
"locale": "nl-NL",
"createdAt": 1726300000,
"updatedAt": 1726500000
}
}