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.
Account ID.
Email addresses of the clients the form is shared with. Adding the first
email shares the form and stamps publishDate; removing all emails clears
publishDate (see publishDate). A client can retrieve the form through
GetClientIntakeForm only if their email is listed here.
Client name.
AI-generated background context for the intake form, stored as free-form
text. Used as input when generating the questionnaire; stored and returned
as-is and not otherwise interpreted by this service. Returned only when
CONTEXT is included in the request's fields.
Date and time the IntakeForm was created.
Free-form custom data stored verbatim with the intake form. Accepts any JSON structure, isn't interpreted or validated by the service, and is returned as-is. Use it to attach your own structured data to an intake form.
Intake form ID.
Project information.
Date and time the form was first shared with clients (the first time client emails were added). Cleared if all client emails are removed; re-stamped if client emails are added again.
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.
Source materials used as input for AI generation.
Submission state of the form. Populated asynchronously from Wix Forms submission events once the client submits, so these fields may be empty until a submission has been received and processed.
IDs of the team members to notify about the 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 IntakeForm was last updated.
Owner user ID.