renameExtendedField( )

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 an extended field.

The renameExtendedField() function returns a Promise that resolves when the specified extended field's display name is changed

Admin Method

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

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Contact Extended Fields
Manage Members and Contacts - all permissions
Learn more about permission scopes.
Method Declaration
Method Parameters

Extended field key.

When accessing contact data, extended field values are available at fields[key]. For example, if the key is "custom.notes", the value can be accessed at fields["custom.notes"].

Once set, key cannot be modified, even if displayName changes.


Extended field to rename.

Return Type:Promise<ExtendedField>
Was this helpful?