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

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

Permissions
Manage Members and Contacts - all permissions
Manage Contact Extended Fields
Learn more about app permissions.
Method Declaration
Copy
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>
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?