renameLabel( )

Renames a label.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Members and Contacts - all permissions
Manage Contact Labels
Learn more about app permissions.
Method Declaration
Copy
function renameLabel(
  key: string,
  label: RenameLabel,
  options: RenameLabelOptions,
): Promise<ContactLabel>;
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>
JavaScript
import { labels } from "@wix/crm";

async function renameLabel(key, label, options) {
  const response = await labels.renameLabel(key, label, options);
}
Errors

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

Did this help?