Form Template Object


A form template is a reusable definition of a form's fields, steps, and settings. It's used as the source when creating a form. App owners define templates for their namespace in the app dashboard, and this API retrieves them.

Properties
autoFillContactstring

createdDatestringRead-onlyformat date-time

Date and time the form template was created.


fieldGroupsArray <FieldGroup>maxItems 50

Groups of related fields, gathered under a shared label on the form's layout.


formFieldsArray <Field>maxItems 100

Fields of the form, such as text inputs, and display elements, such as the submit button. Each step's layout places a field by referencing the field's id.


idstringRead-onlyformat GUID

Form template ID.


namestringminLength 1maxLength 200

Display name of the template.


namespacestringminLength 10maxLength 50immutable

Namespace that groups this template with the templates and forms belonging to the same app or use case, such as a bookings or pricing plans checkout. The value is defined by the app that owns the template in the app dashboard, and is the value you pass when retrieving form templates.


quizSettingsQuizSettings

Quiz configuration applied to forms created from this template.


requiredIndicatorPropertiesRequiredIndicatorProperties

How required fields are marked on the form: the indicator that's displayed, for example an asterisk, and its placement relative to the field title.


stepsArray <Step>maxItems 100

Steps of the form. Each step represents a page of the form and determines its layout.


submitSettingsSubmitSettings

Settings that determine what happens after the form is submitted, such as displaying a thank you message, redirecting to a URL, or opening a popup.


updatedDatestringRead-onlyformat date-time

Date and time the form template was last updated.

Did this help?