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 delete it with deleteLabel().

Note: Only visitors with Manage Contacts permissions can unlabel contacts. You can override the permissions by setting the suppressAuth option to true.

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.

optionsAuthOptions

Authorization options.

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