Introduction
APIs in Developer Preview are subject to change and are not intended for use in production.
Send us your suggestions for improving this API. Your feedback is valuable to us.
The Labels API provides functionality for managing labels for your site. Labels allow site admins to segment or categorize the contacts in their Contact List. Using Labels enchances the CRM by allowing site admins to customize data organization according to their needs. For example, you can use labels to target specific audiences for email campaigns or bulk actions. Learn more about labels.
With the Labels API, you can:
Before you begin
It is important to note the following points before you begin to code:
- When you delete a label from your site, you also remove that label from all contacts it applies to.
- Label keys can't be changed once created.
To use the Labels API, import { labels } from the wix-crm.v2 module.
javascript | Copy Codeimport { labels } from 'wix-crm.v2';
Permissions information
Functions in the Labels API are restricted and only run if you elevate permissions using the wix-auth elevate() function.
Warning: Elevating a function allows it to be called by any site visitor. Exercise caution to prevent security vulnerabilities.
Terminology
- Label: A tag that is applied to contacts to help site admins organzie and group contacts with shared characteristics. Labels can be user-defined or system-defined.
- User-defined label: A label that is custom created by site admins.
- System-defined label: A label that is pre-defined in your site and cannot be deleted from the CRM.
Was this helpful?