Submission Object


Form submission that was created or retrieved.

Properties
accessRestrictionstringformat GUIDimmutable

Authorized viewer ID.


appointmentDetailsAppointmentDetails

Appointment details. This object is only applicable when submitting a form that creates a booking appointment.


contactIdstringformat GUIDimmutable

Contact ID of a site visitor who created the submission.


_createdDateDateimmutable

Date and time the form submission was created.


extendedFieldsExtendedFields

Data extension object that holds users' and apps' fields.


formIdstringformat GUIDimmutable

ID of the form which the submission belongs to.


_idstringRead-onlyformat GUID

Submission ID.


namespacestringRead-onlyminLength 10maxLength 50

The app which the form submissions belong to. A submission inherits the namespace from its form schema, so you can't set it directly.

For example, a submission of a form visible in the Wix Forms app has the namespace wix.form_app.form, the namespace of the Wix Forms app, whose app ID is 225dd912-7dea-4738-8688-4b8c6955ffc2.

See a list of namespaces for apps made by Wix section. To retrieve the ID for a Wix app, see Apps Created By Wix.


orderDetailsOrderDetails

Order details.
Note: This object is only applicable when submitting a form in the Wix Payments app.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the form submission is updated. To prevent conflicting changes, the existing revision must be used when updating a form submission.


seenboolean

Whether a site owner marked a submission as "seen".


statusstring

submissionsRecord <string, Value>format map

Values the visitor submitted.

Each key is the target of a field in the form schema, which is the field's stable storage key rather than its ID or label. Only keys matching a field target are accepted.

Each value's shape follows that field's inputType: STRING fields submit a string, NUMBER a number, BOOLEAN a boolean, and ARRAY an array of the selected option values. Date and time fields are strings. A choice field submits an option's value, not its ID or its label.

3 input types submit structured values: ADDRESS submits an address object, PAYMENT an array holding 1 product object per item bought, and SCHEDULING an appointment object.

For the full mapping, see About Submission Values.


submitterSubmitterRead-only

ID of the visitor that submitted the form.


tagsPublicTags

Tag IDs collections associated with the current entity.


_updatedDateDateRead-only

Date and time the form submission was updated.

Did this help?