About the Contacts API

The Contacts API provides functionality for creating and managing contacts.

The Contacts API contains the following APIs:

• Contacts - This API allows you to manage the contact details for contacts on a site.
• Labels - This API allows you to manage contact labels. Once a label is created, it can be assigned to a contact using the Contacts API.
• Extended Fields - This API allows you to create and manage additional fields for contacts.

Use Cases

• Periodically export new Wix contacts to an external CRM
• Sync with an external system in Real Time
• Create new contacts from an external form
• Sync subscribed enails with an email delivery service

Terminology

• Labels: Tags that help Wix users categorize and organize their contacts. Labels can be system-defined or user-defined. You can manage a site's labels with the Labels API. A contact's assigned labels are available in the contact object under info.labelKeys.

• Extended fields: Additional properties that store additional contact information. A contact's extended field data is available in the contact object under info.extendedFields. Extended field definitions can be created and managed with the Extended Fields API.

  There are 2 types of extended fields:

  • System fields: Extended fields created by apps built by Wix. System fields often enrich contacts with data from apps built by Wix, such as Wix Stores or Wix Members. System fields can't be renamed and are typically read-only.
  • Custom fields: Extended fields added by Wix users. Custom fields can be renamed, and their data can be written by any Wix user.