Update a contact

patch

https://api.emaktalk.com/api/v1/contacts/{contactId}

Updates a contact and returns it. The contact object is a true partial update — only the keys you send are written — but phones, emails and addresses are wholesale replacements: any stored entry whose ID is missing from the array you send is deleted, so read the contact first and send the complete list. Phone numbers are re-normalized to E.164 on write, and deletions are recorded in the audit log. The update is not atomic, so a partial failure answers 400 with some changes already applied.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

contactId

string

required

ID of the contact to update.

Body Params

contact

object

Partial update of the contact itself — any of organization, first_name, last_name, display_name, note, visibility, is_starred, show_on_deskphone; visibility (domain or private) is applied only when you own the contact or hold the Admin role, and any other value is ignored.

phones

string

Full replacement of the contact's phone numbers as {contact_phone_uuid?, phone_number, type, is_primary}; entries with a known ID are updated, entries without one are created, and any stored number you leave out is deleted.

emails

string

Full replacement of the contact's email addresses as {email_uuid?, email_address, type, is_primary}; any stored address you leave out is deleted.

addresses

string

Full replacement of the contact's addresses as {address_uuid?, type, street, address_extended, city, region, postal_code, country}; any stored address you leave out is deleted.

contact_email

object

Older single-email field kept for existing callers; use emails instead.

contact_address

object

Older single-address field kept for existing callers; use addresses instead.

Responses

200

The updated contact.

401

Missing or invalid API key.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400No contact ID was supplied, or one of the sub-operations failed — the message names which.

403The contact is private and you neither own it nor hold the Admin role.

404No such contact on your account.

500The access check or the re-read after the update failed.