getLabel( )

Retrieves a label by the specified label key.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Bookings Services and Settings
Manage Contact Labels
Manage Events
Manage Portfolio
Access Verticals by Automations
Set Up Automations
Manage Members and Contacts - all permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
keystringRequired

Label key.

key is generated when the label is created. It can't be modified, even if displayName is updated.

optionsGetLabelOptions

Language options.

Returns
Return Type:Promise<ContactLabel>
JavaScript
Errors

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

Did this help?