findOrCreateExtendedField( )

Retrieves a custom field with a specified name, or creates one if it doesn't exist. The number of custom fields is limited to 100.

Successful calls to this method always return a field, which can be specified in subsequent calls.

To find an existing custom field without potentially creating a new one, call Get Extended Field or Query Extended Fields.

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 findOrCreateExtendedField(
  displayName: string,
  dataType: FieldDataType,
): Promise<FindOrCreateExtendedFieldResponse>;
Method Parameters
displayNamestringRequired

Display name to retrieve or create.

If an existing custom field is an exact match for the specified display name, the existing field is returned. If not, a new field is created and returned.

dataTypeFieldDataTypeRequired

Type of data the field holds. Ignored if an existing field is an exact match for the specified display name.

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

async function findOrCreateExtendedField(displayName, dataType) {
  const response = await extendedFields.findOrCreateExtendedField(
    displayName,
    dataType,
  );
}
Errors
429Resource Exhausted

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?