An intake form gathers project information from a partner's client. It wraps a questionnaire with project context, the source materials used to tailor that questionnaire, the clients the form is shared with, and the client's submission state.
The questionnaire is generated with AI the first time the form is opened, and
the resulting context is stored on the intake form. This API stores the
generated content but doesn't perform the generation itself.
ID of the partner account that owns the intake form. Set automatically from the caller's identity when the intake form is created.
Email addresses of the clients the intake form is shared with. A client must sign in with one of these email addresses to open the form.
Adding the first email address shares the form and sets publishDate.
Removing all email addresses clears publishDate.
The client's interaction with the form: when they last edited it and when they
submitted it. The form is considered submitted only when
clientFormInteraction.submissionDate is set.
Updated asynchronously after the client edits or submits the form, so it may be empty for a short time afterward.
Name of the client the intake form is for.
AI-generated background context for the intake form, in free-form text. Used to tailor the questionnaire. Stored and returned as is.
Returned only when CONTEXT is included in the request's fields.
Date and time the intake form was created.
Custom data to store with the intake form. Accepts any JSON structure, isn't validated, and is returned as is. Use it to attach your own structured data to an intake form.
Intake form ID.
Title and message shown to the client on the intro screen, before they sign in.
Returned only when INTRO_DATA is included in the request's fields.
Language of the form's content and client experience, as a 2-letter language
code in ISO 639-1 alpha-2
format. For example, en, de, or ja.
Can be set only when the intake form is created.
Default: en
Client project the intake form collects content for.
Date and time the intake form was shared with clients, meaning when the first
email address was added to clientEmails.
Cleared when all email addresses are removed from clientEmails, and set again
when email addresses are added back. Set asynchronously, shortly after the
change.
Revision number, which increments by 1 each time the intake form is updated. To prevent conflicting changes, the current revision must be passed when updating the intake form.
Ignored when creating an intake form.
Partner-provided materials used to generate the questionnaire.
Returned only when SOURCE_MATERIALS is included in the request's fields.
IDs of the team members to notify about the intake form. Listed team members are notified through Wix Automations when the client submits the form or adds a note to it.
Date and time the intake form was last updated.
ID of the user who owns the intake form. Set automatically from the caller's identity when the intake form is created.