unlabelContact( )

Removes labels from a contact.

The unlabelContact() function returns a Promise that resolves when the specified labels are removed from the contact.

If a label is no longer needed and you want to remove it from all contacts, you can remove it with the Labels deleteLabel() function.

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 remove labels from.

labelKeysArray<string>Required

List of label keys to remove from the contact.

optionsUnlabelContactOptions
Returns
Return Type:Promise<UnlabelContactResponse>
Was this helpful?
Yes
No