updateContact( )
Updates a contact's properties.
The updateContact()
function returns a Promise that resolves
when the specified contact's information is updated.
Each time the contact is updated, revision
increments by 1. The existing revision
must be included when updating the contact. This ensures you're working with the latest contact information, and prevents unintended overwrites.
Admin Method
This function requires elevated permissions and runs only on the backend and on dashboard pages.
Permission Scopes
For app development, you must have one of the following permission scopes:Manage Contacts
Manage Members and Contacts - all permissions
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
contactIdstringRequired
ID of the contact to update.
infoContactInfoRequired
Contact info.
revisionnumberRequired
Revision number. When updating, include the existing revision to prevent conflicting updates.
optionsUpdateContactOptions
Contact update options.
Returns
Return Type:Promise<UpdateContactResponse>
Was this helpful?
Yes
No