deleteLabel( )

Deletes the specified label from a site and removes it from the contacts it applies to.

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 Challenges
Manage Members and Contacts - all permissions
Manage Contact Labels
Learn more about app permissions.
Method Declaration
Copy
function deleteLabel(key: string): Promise<void>;
Method Parameters
keystringRequired

Label key to delete.

JavaScript
import { labels } from "@wix/crm";

async function deleteLabel(key) {
  const response = await labels.deleteLabel(key);
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?