This article presents possible use cases and corresponding sample flows that you can support. This can be a helpful jumping-off point as you plan your implementation.
You can identify customers who haven't filled out required intake forms and send them submission links. This is useful for ensuring compliance before appointments or events.
To send intake forms to customers who haven't completed them:
mostRecentSubmission exists with status of VALID, EXTENDED, or EXEMPT. If not, the contact needs to complete the form.You can automatically approve all intake forms for a specific customer group without requiring them to fill out forms. This is useful for VIP customers or special circumstances.
To approve all forms for a customer group:
mostRecentSubmission.status is VALID, EXTENDED, or EXEMPT, no action is needed.mostRecentSubmission.status is EXPIRED, call Extend Intake Form Submission to revalidate.mostRecentSubmission exists, call Exempt Intake Form Submission to mark as exempt.You can create an intake form submission programmatically when customers have completed forms offline, such as paper forms or phone calls. This is useful for importing existing waivers from another system.
To create a submission on behalf of a customer:
fields to identify required field keys.data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA....formId: The intake form ID.submissions: An object with field keys and values. Include at least firstName and email. Add signature if required.contactId: The customer's contact ID.
An intake form submission is automatically created. Its signer field is populated from the form submission's firstName, lastName, email, and contactId.