renameLabel( )


Renames a label.

Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

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?