getLabel( )


Retrieves a label.

The getLabel() function returns a Promise that resolves when the specified label is retrieved.

Note: Only visitors with Manage Contacts permissions can retrieve labels. You can override the permissions by setting the suppressAuth option to true.

Method Declaration
Copy
Method Parameters
keystringRequired

Label key.

key is generated when the label is created and cannot be modified, even if displayName changes.


optionsAuthOptions

Authorization options.

Returns
Return Type:Promise<Label>
Errors

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

Did this help?