deleteLabel( )
Developer Preview
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Deletes a label from the site and removes it from contacts it applies to.
The deleteLabel()
function returns a Promise that resolves when the specified label is deleted.
Admin Method
This function requires elevated permissions and runs only on the backend and on dashboard pages.
Permission Scopes
For app development, you must have one of the following permission scopes:Manage Contact Labels
Manage Members and Contacts - all permissions
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
keystringRequired
Label key to delete.
Was this helpful?
Yes
No