renameLabel( )


Renames a label.

Authentication

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

Permissions
Manage Members and Contacts - all permissions
Manage Contact Labels
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.


labelRenameLabelRequired

Label to rename.


optionsRenameLabelOptions

Language options.

Returns
Return Type:Promise<ContactLabel>
Errors

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

Did this help?