Optional
approvalOptional
approvalThe identifier for the email template to use when notifying approvers of a new approval to action
Optional
approveA list of canned responses available for the form that can be assigned when approving an approval
Optional
approvedThe identifier for the email template to use when notifying the user that submitted the form that an approver has approved their submission
Optional
autoConfiguration for automatically denying an approval after a number of
days when a clarification request has been sent with no response. Set
undefined
or unset for no Auto Deny.
The amount of days after a clarification request has been sent with no response until the approval is automatically denied.
Optional
internalInternal notes that are not seen by the user that submitted the form
Optional
notify?: { Optional
cannedKey to associate a canned response with an approval to allow for reporting
Notes sent to specified users
Optional
notificationThe email addresses of the users to be notified of the result. If the
approval flow has a defaultNotificationEmailElementId
configured,
this address will also receive a notification email.
Optional
clarificationA list of canned responses available for the form that can be assigned when requesting clarification
Optional
clarificationThe identifier for the email template to use when notifying the user that submitted the form that an approver has requested clarification
Optional
defaultThe id of the element to use as a default prefill for the notification email address when actioning an approval for this form
Optional
defaultAllow a default value for the preventPayment
flag when approvers are
requesting clarification
Optional
deniedThe identifier for the email template to use when notifying the user that submitted the form that an approver has denied their submission
Optional
denyA list of canned responses available for the form that can be assigned when denying an approval
Optional
disallowDisallow approving when approval is waiting for clarification
Optional
pendingConfiguration for sending recurring reminders at an interval of days to Approvers of pending approvals for this form.
The amount of days that make up the interval at which reminder emails will be sent to approvers of pending approvals.
Optional
approvalOptional
approvalOptional
cancelOptional
continueWhether or not viewing the form should auto-continue with autosave data when available rather than prompting the user
Optional
customCustom CSS classes that will be added to the form during rendering
A description of the form.
Optional
draftAll elements contained within the form itself.
Optional
externalThe details of the externalId generation endpoint which will be executed after "serverValidation" but before submission.
The forms app environment ID the form belong to.
ID's of any Forms Apps that the form is included in.
Whether or not the form can only be viewed by an Authenticated user.
Whether or not the form contains multiple pages.
Name of the form.
The organisation ID the form belong to.
Optional
paymentOptional
personalisation?: EndpointConfigurationThe details of the personalisation endpoint which will be executed on form load to prefill existing elements or return a new set of elements.
The action for the Form to take on a successful submission.
Optional
postConfiguration to customise the display after a successful submission.
Optional
allowPDFDownload?: PDFConfigurationWhether or not to generate a token to allow downloading the form submission PDF after a successful submission.
Optional
html?: stringHTML to display instead of the default "Thank you" message after a successful submission.
Optional
publishThe date and time (in ISO format) a form becomes unavailable.
Optional
publishThe date and time (in ISO format) a form becomes available.
Optional
redirectThe URL the form will redirect to if configured to do so by the
postSubmissionActions
.
Optional
schedulingOptional
serverThe details of the form validation endpoint.
Events that occur/trigger on a valid successful submission.
Optional
submissionThe title of a form submission, supports element injection
A list of tags used to categorise or describe the form.
Optional
unpublishedThe message to be shown to forms users when the form is not in the published time window
Optional
updatedThe id of the key
The name of the key
Optional
updatedThe user that last updated the form
Configuration options that affect the whole approval flow