About the Intake Form Submissions API

The Intake Form Submissions API lets you manage submissions for intake forms. A submission represents a contact's completion of an intake form, with status tracking, expiration management, and lifecycle operations.

With the Intake Form Submissions API, you can:

• Query, search, and count intake form submissions, and retrieve the most recent submission per contact.
• Identify forms without submissions.
• Extend expiration dates, cancel submissions, or exempt contacts from submitting forms.

Before you begin

It's important to note the following points before starting to code:

• The Wix Forms app isn't required.
• You can create intake form submissions in 2 ways:
  • Generate a link with Create Customer Submission Link for customers to complete forms themselves.
  • Call Wix Forms' Create Submission to create a submission programmatically on behalf of a customer.
• A submission's expiration date is calculated from the creation date plus the intake form's expiration period in months. When a submission expires, or you cancel it, it remains in the system for record-keeping.
• When you extend a submission, you reset the expiration date to keep it valid for another expiration period.
• When an intake form is deleted, its submissions become orphaned. Orphaned submissions aren't returned by any of this API's methods.
• List Intake Form Data By Contacts returns both intake forms without submissions and the most recent submission per contact. This allows you to easily validate intake form requirements for a group of contacts.

Use cases

• Send intake forms to customers who haven't completed them.
• Approve all forms for a customer group.
• Create a submission on behalf of a customer.
• Extend submission expiration dates.

Terminology

• Intake form submission: A record representing a contact's completion of an intake form. Each submission has one of these statuses: VALID, EXPIRED, CANCELED, EXTENDED, or EXEMPT.
• Expiration date: The date and time when a submission expires. Calculated from the creation date plus the intake form's expiration period, but can be manually extended.
• Extend submission: Resetting a submission's expiration date to keep it valid for another expiration period. Changes the status from EXPIRED back to VALID.
• Cancel submission: Marking a submission as invalid by changing its status to CANCELED. The submission remains in the system for record-keeping.
• Exempt submission: Marking a contact as exempt from submitting a form. Creates a submission with status EXEMPT.

See also

• Intake Forms API
• Wix Forms API