renameLabel( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Renames a label.

The renameLabel() function returns a Promise that resolves when the specified label's display name is changed.

Authentication

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

Permissions
Manage Contact Labels
Manage Members and Contacts - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
keystringRequired

Label key.

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

labelRenameLabelRequired

Label to rename.

optionsRenameLabelOptions

Language options.

Returns
Return Type:Promise<ContactLabel>
Was this helpful?
Yes
No