labelContact( )

Adds labels to a contact.

The labelContact() function returns a Promise that resolves when the specified labels are added to the contact.

  • To create new labels: Use findOrCreateLabel().
  • To find labels: Use findOrCreateLabel(), getLabel(), or queryLabels().
Authentication

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

Permissions
Manage Contacts
Manage Members and Contacts - all permissions
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. Contact labels can be created with the findOrCreateLabel() function. You can use the queryLabels() function to view the currently existing labels.

optionsLabelContactOptions
Returns
Return Type:Promise<LabelContactResponse>
Did this help?