Contact Object


A contact represents a person in a site's contact list. It stores profile details such as name, email addresses, phone numbers, and addresses, and can optionally be linked to a site member.

Properties
additionalEmailsArray <AdditionalEmail>maxItems 10

Additional emails of the contact. These emails do not affect subscription status or contact matching/deduplication. The main email field must be set before additional emails can be added.


additionalPhonesArray <AdditionalPhone>maxItems 10

Additional phones of the contact. These phones do not affect subscription status or contact matching/deduplication. The main phone field must be set before additional phones can be added.


addressesArray <ContactAddress>maxItems 50

Contact's physical addresses. Each address can be tagged (HOME, WORK, BILLING, SHIPPING, OTHER) and one can be set as default. If no address is marked as default, the first address automatically becomes the default.


assigneeIdstringformat GUID

Site contributor user ID assigned to manage communication with this contact. Must be a valid GUID referencing an existing site contributor. Only one assignee can be set per contact.


birthdatestringformat LOCAL_DATE

Birth date in YYYY-MM-DD format. For example, 2020-03-15.


companyContactCompany

Contact's company information including company name and job title.


createdDatestringRead-onlyimmutableformat date-time

Date and time the contact was created.


emailContactEmail

The main email of the contact with subscription status and deliverability information. This email is used for contact matching and deduplication logic.


extendedFieldsExtendedFields

Extended fields for storing custom contact data beyond the standard fields. Allows adding custom properties specific to business needs. To define a custom extended field, use the Schema Service API with the contacts FQDN: wix.contacts.*.contact.


externalIdstringmaxLength 100

Contact external ID. Used to identify contacts from external systems. This field can only be set once and can't be updated after creation.


idstringRead-onlyformat GUIDimmutable

Contact ID.


imageImage

Contact's profile image.


lastActivityContactActivityRead-only

Details about the contact's most recent activity on the site. Includes activity date and template ID. This field is read-only and updated automatically.


localestringformat LANGUAGE_TAG

Locale in IETF BCP 47 language tag format. Typically, this is a lowercase 2-letter language code, followed by a hyphen, followed by an uppercase 2-letter country code. For example, en-US for U.S. English, and de-DE for Germany German.


locationIdsArray <string>format GUIDmaxItems 50

List of business location IDs associated with this contact. Used for multi-location businesses to organize contacts by physical business locations. Each ID must be a valid GUID referencing an existing business location.


memberInfoMemberInfoRead-only

Contact's site membership information including member ID, status, and profile details. This field is read-only and populated automatically when the contact is also a site member.

Updates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed.


nameContactName

Contact's name information including first and last name.


phoneContactPhone

The main phone of the contact with subscription status and deliverability information. This phone is used for contact matching and deduplication logic. At least one of name, email, or phone is required for contact creation.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the Contact is updated. To prevent conflicting changes, the current revision must be passed when updating the Contact.

Ignored when creating a Contact.


segmentIdsArray <string>Read-onlymaxItems 60format GUID

IDs of the segments the contact belongs to. Segments are used for organizing and targeting groups of contacts.


sourceContactSourceimmutable

Details about the origin of the contact. This field is immutable and set automatically when the contact is created.


tagsPrivateTags

Tags assigned to the contact for organization and filtering.


timeZonestringmaxLength 50

IANA time zone identifier for the contact's location. Valid values are IANA time zone IDs, such as 'Europe/Rome' or 'America/New_York'.


updatedDatestringRead-onlyformat date-time

Date and time the contact was last updated.

Did this help?