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

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Members and Contacts - all permissions
Manage Contacts
Manage Stores
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.

optionsLabelContactOptions
Returns
Return Type:Promise<LabelContactResponse>
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?