About the Custom Fields API

The Custom Fields API allows you to create and manage custom fields to allow members to share any info relevant to a site. For example, you can add fields for a member to share their favorite animal or astrological sign.

By default, a member gets the following system fields in their profile after signing up:

  • First name
  • Last name
  • Phone

The Members Area provides additional system fields that a Wix user can only add in the dashboard:

  • Address
  • Birth date
  • Company
  • Position

With the Custom Fields API, you can:

  • Create a custom field.
  • Retrieve information about all fields (custom and already provided by the Members Area).
  • Delete and hide a custom field.
  • Update a custom field.

Before you begin

It’s important to note the following before starting to code:

  • A site must have the Wix Members Area installed from the App Market.
  • By default, a custom field is assigned to all members on a site. If you wish to assign the custom field only to specific members or entities, use the Custom Field Applications API after creating the custom field.

Use cases

Terminology

  • Custom Field: A user-defined field that extends the default member profile information.
  • System Field: A Wix-defined field from the default member profile information.
Did this help?