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

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

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

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.

fieldRenameExtendedFieldRequired

Extended field to rename.

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