POST

Find Or Create Extended Field


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

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.
Endpoint
POST
https://www.wixapis.com/contacts/v4/extended-fields

Body Params
displayNamestringRequiredminLength 1maxLength 150

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.


dataTypestring

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

Response Object
fieldField

Extended field that was found or created.


newFieldboolean

Indicates whether the extended field was just created or already existed.

Returns true if the field was just created.

Find or Create Extended Field
Request
cURL
curl -X POST 'https://www.wixapis.com/contacts/v4/extended-fields' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' \ --data-binary '{ "displayName": "My Field" "dataType" : "TEXT" }'
Response
JSON
{ "field": { "namespace": "custom", "key": "custom.my-field", "displayName": "My Field", "dataType": "TEXT", "fieldType": "USER_DEFINED", "createdDate": "2020-05-10T07:14:59Z", "updatedDate": "2020-05-10T07:14:59Z" }, "newField": true }
Errors
429Resource Exhausted

There is 1 error with this status code.

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

Event TriggersThis method triggers the following events:
Did this help?