labelContact( )

Adds labels to a contact.

Use the Labels API to create or retrieve labels.

Members are typically linked to contacts, and while they share a relationship, the member ID and contact ID are distinct identifiers. Make sure to specify the contact ID when calling Label Contact.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Members and Contacts - all permissions
Manage Contacts
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
contactIdstringRequired

ID of the contact to add labels to.

labelKeysArray<string>Required

List of label keys to add to the contact.

Label keys must exist to be added to the contact. Use the Labels API to create or retrieve labels.

Returns
Return Type:Promise<LabelContactResponse>
JavaScript
Errors
404Not Found

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?