Update a contact

patch

https://api.ycloud.com/v2/contact/contacts/{id}

Updates a contact. If every supplied persisted contact field already has
the requested value, the contact is not updated and no
contact.attributes_changed event is emitted. Note mutations in the
same request are still applied.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

length ≤ 255

Identifier of the contact. Supports a contact ID, a phone number in E.164 format starting with + (for example, +16315551111), or a Meta username without the leading @.
A Meta username must contain 3 to 35 letters, digits, periods, or underscores. If a numeric value can be interpreted as both a Meta username and a contact ID, it is resolved as a Meta username first. If no contact has that Meta username, the value is resolved as a contact ID.

Body Params

Contains the properties of the contact to be updated.

remarkName

string

length ≤ 250

Contact's remark name. Maximum length: 250 characters.

nickname

string

length ≤ 250

deprecated

Deprecated compatibility alias for remarkName.
When remarkName is absent, this value is saved as the contact's remark name. It does not update the read-only WhatsApp nickname.
Maximum length: 250 characters.

phoneNumber

string

Unique Phone number in E.164 format.

countryCode

string

Two-letter country abbreviation. See ISO 3166-1 alpha-2 country code.

string

length ≤ 250

The contact's email address.
If present, the email address must be unique.

tags

customAttributes

array of objects

Contact's custom attributes.
If present (i.e., not null), all previous attributes of this contact will be replaced.

customAttributes

ownerEmail

string

length ≤ 250

The email address of the contact's owner.

notes

array of objects

length ≤ 50

Optional incremental note mutations. An empty array changes nothing. Items without id create notes;
items with id update owned notes. Notes not listed remain unchanged. Delete notes with the dedicated endpoint.

notes

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

200Successfully updated the contact.

400The notes array, note ID, or note content is invalid.

404The contact or referenced contact note does not exist, or the note is not owned by the contact.