> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # DeleteLabel # Package: contacts # Namespace: ContactLabelsServiceV4 # Method link: https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/labels/delete-label.md ## Permission Scopes: Manage Contact Labels: SCOPE.DC-CONTACTS.MANAGE-LABELS ## Introduction Deletes the specified label from a site and removes it from the contacts it applies to. --- ## REST API ### Schema ``` Method: deleteLabel Description: Deletes the specified label from a site and removes it from the contacts it applies to. URL: https://www.wixapis.com/contacts/v4/labels/{key} Method: DELETE # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: key Method parameters: param name: key | type: none | required: true Return type: DeleteLabelResponse EMPTY-OBJECT {} ``` ### Examples ### Delete Label ```curl curl -X DELETE 'https://www.wixapis.com/contacts/v4/labels/custom.my-label' \ -H 'Content-Type: application/json' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.contacts.ContactLabelsServiceV4.deleteLabel(key) Description: Deletes the specified label from a site and removes it from the contacts it applies to. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: key Method parameters: param name: key | type: string | description: Label key to delete. | required: true Return type: PROMISE EMPTY-OBJECT {} ``` ### Examples ### Delete a label (with elevated permissions) ```javascript import { labels } from '@wix/crm'; import { auth } from '@wix/essentials'; /* Sample key value: 'custom.at-risk' */ const elevatedDeleteLabel = auth.elevate(labels.deleteLabel); export async function myDeleteLabelFunction(key) { try { const deletedLabel = await elevatedDeleteLabel(key); console.log('Label deleted.'); } catch (error) { console.log(error); // Handle the error } } /* Promise resolves to void */ ``` ### Delete a label ```javascript import { labels } from '@wix/crm'; /* Sample key value: 'custom.at-risk' */ export async function myDeleteLabelFunction(key) { try { const deletedLabel = await labels.deleteLabel(key); console.log('Label deleted.'); } catch (error) { console.log(error); // Handle the error } } /* Promise resolves to void */ ``` ### deleteLabel (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { labels } from '@wix/crm'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { labels }, // Include the auth strategy and host as relevant }); async function deleteLabel(key) { const response = await myWixClient.labels.deleteLabel(key); }; ``` ---