Extended Field Object


Extended field that was found or created.

Properties
namespacestringRead-onlyminLength 1maxLength 25

Extended field namespace.

Extended fields created through by calling the Find Or Create Extended Field method are automatically assigned to the custom namespace.


keystringRead-onlyminLength 1maxLength 80

Extended field key.

When accessing contact data, extended field data is available at extendedFields[key]. For example, if the key is "custom.notes", the value can be accessed at extendedFields["custom.notes"].

key is generated when the extended field is created and can't be modified, even if displayName changes.


displayNamestringminLength 1maxLength 150

Display name shown in the contact list.


dataTypestringRead-only

Type of data the field holds.


fieldTypestringRead-only

Indicates whether the extended field is a system field or custom field.


createdDatestringRead-onlyformat date-time

Date and time the field was created.


updatedDatestringRead-onlyformat date-time

Date and time the field was last updated.


descriptionstringRead-onlyminLength 1maxLength 150

Field description, if the field is a system field.

Did this help?

GET

List Extended Fields


Retrieves a list of extended fields.

Authentication

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

Permissions
Manage Bookings Services and Settings
Manage Portfolio
Manage Members and Contacts - all permissions
Manage Contact Extended Fields
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/contacts/v4/extended-fields

Errors

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

Did this help?

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

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?

GET

Get Extended Field


Retrieves an extended field by the specified extended field key.

Authentication

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

Permissions
Manage Bookings Services and Settings
Manage Portfolio
Manage Members and Contacts - all permissions
Manage Contact Extended Fields
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/contacts/v4/extended-fields/{key}

Errors

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

Did this help?

DELETE

Delete Extended Field


Deletes an extended field.

When an extended field is deleted, any contact data stored in the field is also permanently deleted.

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
DELETE
https://www.wixapis.com/contacts/v4/extended-fields/{key}

Errors

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

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

PATCH

Update Extended Field


Renames an extended field.

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
PATCH
https://www.wixapis.com/contacts/v4/extended-fields/{field.key}

Errors

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

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

POST

Query Extended Fields


Retrieves a list of extended fields.

For a detailed list of supported operations, see sorting and filtering for extended fields. To learn more about query language, see API Query Language.

Authentication

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

Permissions
Manage Bookings Services and Settings
Manage Portfolio
Manage Members and Contacts - all permissions
Manage Contact Extended Fields
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/contacts/v4/extended-fields/query

Errors
400Invalid Argument

There are 6 errors with this status code.

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

Did this help?

Extended Field Created


Triggered when an extended field is created.

Permissions
Manage Bookings Services and Settings
Manage Portfolio
Manage Members and Contacts - all permissions
Manage Contact Extended Fields
Manage Restaurants - all permissions
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.contacts.v4.extended-field.


slugstring

Event name. Expected created.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


createdEventCreatedEvent

Event information.


Did this help?

Extended Field Deleted


Triggered when an extended field is deleted.

Permissions
Manage Bookings Services and Settings
Manage Portfolio
Manage Members and Contacts - all permissions
Manage Contact Extended Fields
Manage Restaurants - all permissions
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.contacts.v4.extended-field.


slugstring

Event name. Expected deleted.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


deletedEventstruct

Event information.


Did this help?

Extended Field Updated


Triggered when an extended field is updated.

Permissions
Manage Bookings Services and Settings
Manage Portfolio
Manage Members and Contacts - all permissions
Manage Contact Extended Fields
Manage Restaurants - all permissions
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.contacts.v4.extended-field.


slugstring

Event name. Expected updated.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


updatedEventUpdatedEvent

Event information.


Did this help?