renameLabel( )

Renames a label.

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

Note: Only visitors with Manage Contacts permissions can rename 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.

displayNamestringRequired

Label display name shown in the Dashboard.

optionsAuthOptions

Authorization options.

Returns

Return Type:Promise<Label>

Was this helpful?

Yes