- Home
- Models
- Form
Form
A form contains many fields, workflows and conditions.
Form fields
Field |
Type |
Fillable |
Reference |
id
|
Integer
|
|
|
The unique ID to identify the form
|
Form relations
account,
conditions,
fields,
fields.child,
fields.children,
fields.conditions,
fields.dependant_conditions,
fields.option,
fields.parent,
fields.integration_fields,
responses,
pages,
pages.fields,
pages.fields.child,
pages.fields.children,
pages.fields.conditions,
pages.fields.dependant_conditions,
pages.fields.option,
pages.fields.parent,
pages.fields.integration_fields,
users,
user,
workflows,
Form endpoints
GET List all forms /forms toggle
Paramaters
- group
-
String
The name of the form group
- module
-
String
The name of the module the form belongs to
Required
- published
-
Boolean
Controls whether the form can be access or receive submissions publicly.
- user_id
-
Reference
Nullable
Indicates the user who created the form.
References user model.
- uuid
-
String
Nullable
A unique string which identifies the form for access via public links.
Example response
GET Return data for a specified Form /forms/:param toggle
Substitute either the UUID, 6 character code or ID into the URL slug to specify which form should be returned.
URL slugs
- code
-
String
The unique 6 character code
- id
-
String
The ID of form, this option is only valid if used with authentication.
- uuid
-
String
The unique UUID of a form
Paramaters
- group
-
String
The name of the form group
- module
-
String
The name of the module the form belongs to
Required
- published
-
Boolean
Controls whether the form can be access or receive submissions publicly.
- user_id
-
Reference
Nullable
Indicates the user who created the form.
References user model.
- uuid
-
String
Nullable
A unique string which identifies the form for access via public links.
Example response
GET Serve custom CSS for this Form /forms/:uuid/css toggle
This endpoint will return only the custom CSS for the specified form, it should be used to embed the CSS into the page displaying the form.
URL slugs
- uuid
-
String
The unique UUID of a form
Paramaters
There are no parameters for this endpoint
Example response
POST Create or update a Form /forms/:id? toggle
This endpoint can be used to either save a new form or update an existing form. Leave the :id URL slug blank to create a new form.
Paramaters
-
Reference
Nullable
Specified which email template will be used to email a user when they are assigned to a response to this form.
References template model.
- auto_redirect
-
Boolean
Controls if the success_url is automatically redirected to after form submission.
- beta
-
String
[No documentation available]
- chat_channel_id
-
String
[No documentation available]
- color
-
String
[No documentation available]
- description
-
String
Nullable
A short description of the form, this is shown to people responding to the form.
- expiry_date
-
Timestamp
Nullable
The date at which point the form will stop accepting more responses.
- first_field_id
-
Reference
Nullable
Specifies which field is used first when listing responses.
References field model.
- full_message
-
String
[No documentation available]
- ga_property
-
String
Used for tracking views using Google Analytics
- group
-
String
The name of the form group
- gtm_id
-
String
Your ID for for Google Tag Manager
- internal_name
-
String
An alternative name for use within the admin system
- language
-
String
[No documentation available]
- max_responses
-
Integer
Nullable
The maximum number of responses the form will accept before rejecting further responses.
- module
-
String
The name of the module the form belongs to
Required
- name
-
String
A name used to easily identify the purpose of the form, this is shown to people responding to the form.
Required
- pages
-
Array
Include an array of page models with their relevant parameters, and within each page an array of field models with their respective parameters. Existing pages or field which are not included in this array when updating a form will be removed.
References page model.
- protected
-
String
[No documentation available]
- published
-
Boolean
Controls whether the form can be access or receive submissions publicly.
- second_field_id
-
Reference
Nullable
Specifies which field is used second when listing responses.
References field model.
- show_continue_button
-
Boolean
Controls if the continue button is shown after a resposne is submitted.
- submit_text
-
String
Nullable
The submit button text shown at the end of the form.
Required
- success_message
-
String
Nullable
This message is shown to the user on successful submission of a response.
- success_url
-
URL
Nullable
Specifies where a respondent should be redirected after completing a submission.
POST Clone Form /forms/:id toggle
Will create a independent copy of a form, including all fields, workflows and conditions.
URL slugs
- id
-
String
The ID of the form to create a clone of.
Paramaters
There are no parameters for this endpoint
POST Sync responses for this Form /forms/:id toggle
All responses for the specified form are synced to the specified integration.
URL slugs
- id
-
String
The ID of the form to sync
Paramaters
-
Reference
Nullable
Specified which email template will be used to email a user when they are assigned to a response to this form.
References template model.
- auto_redirect
-
Boolean
Controls if the success_url is automatically redirected to after form submission.
- beta
-
String
[No documentation available]
- chat_channel_id
-
String
[No documentation available]
- color
-
String
[No documentation available]
- description
-
String
Nullable
A short description of the form, this is shown to people responding to the form.
- expiry_date
-
Timestamp
Nullable
The date at which point the form will stop accepting more responses.
- first_field_id
-
Reference
Nullable
Specifies which field is used first when listing responses.
References field model.
- full_message
-
String
[No documentation available]
- ga_property
-
String
Used for tracking views using Google Analytics
- group
-
String
The name of the form group
- gtm_id
-
String
Your ID for for Google Tag Manager
- integration
-
String
The type of integration to sync with.
- internal_name
-
String
An alternative name for use within the admin system
- language
-
String
[No documentation available]
- max_responses
-
Integer
Nullable
The maximum number of responses the form will accept before rejecting further responses.
- module
-
String
The name of the module the form belongs to
Required
- name
-
String
A name used to easily identify the purpose of the form, this is shown to people responding to the form.
Required
- protected
-
String
[No documentation available]
- published
-
Boolean
Controls whether the form can be access or receive submissions publicly.
- second_field_id
-
Reference
Nullable
Specifies which field is used second when listing responses.
References field model.
- show_continue_button
-
Boolean
Controls if the continue button is shown after a resposne is submitted.
- submit_text
-
String
Nullable
The submit button text shown at the end of the form.
Required
- success_message
-
String
Nullable
This message is shown to the user on successful submission of a response.
- success_url
-
URL
Nullable
Specifies where a respondent should be redirected after completing a submission.
DELETE Delete a Form /forms/:id toggle
Deletes the form. Responses to this form will not be deleted.
URL slugs
- id
-
String
The ID of the form to delete
Paramaters
There are no parameters for this endpoint