renameExtendedField( )

Renames an extended field.

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 Extended Fields
Learn more about app permissions.
Method Declaration
Copy
function renameExtendedField(
  key: string,
  field: RenameExtendedField,
): Promise<ExtendedField>;
Method Parameters
keystringRequired

null

fieldRenameExtendedFieldRequired

null

Returns
Return Type:Promise<ExtendedField>
JavaScript
import { extendedFields } from "@wix/crm";

async function renameExtendedField(key, field) {
  const response = await extendedFields.renameExtendedField(key, field);
}
Errors

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

Did this help?