On January 2021 we released the version 2.3 of the FormBuilder API. This new version includes performance improvements and a better respect of HTTP protocol for RestFull APIs. All v2.0 URIs of the FormBuilder API are available in v2.3. If you are currently using the v2.0 of the FormBuilder API, we encourage you to update to the newer version. The new documentation is available here here.
| Parameter name | Value | Description |
|---|---|---|
id |
string |
Identifier of the form. Read-only |
name |
string |
Name of the form. Max length: 255. |
title |
string |
Title of the form. Max length: 255. |
submitMessage |
string |
Message of the form after validation. Max length: 65535. |
fields[] |
list |
Fields of the form. |
fields[].id |
string |
Id of the fields. Read only. |
fields[].type |
string |
Type of the field. Values: "address", "checkbox", "date", "email", "input", "name", "number", "phone", "price", "radio", "scalerating", "select", "start", "textarea", "website". |
fields[].label |
string |
Label of the field. |
fields.mandatory |
boolean |
If the field is mandatory. |
fields[].order |
integer |
Order number of the fields. First field of the form has order number 0 |
fields[].key |
string |
Key of the field. |
fields[].values |
string |
Values list of the field. Only used for "checkbox", "select" and "radio" field types. |
followUp |
boolean |
Enable or disable follow up feature. |
emailNotifications |
boolean |
Enable or disable account email notification. |
emailNotifications |
array[string] |
List of email adresses to notify for each form filled. |
clientEmailNotifications |
boolean |
Allow end user to receive an email when he fill a new form. |
finalizeLater |
boolean |
Allow end user to finalized the form later. |
finalizeLaterEmailMessage |
boolean |
Text message displayed when the end user come back to the form. |
Deletes an entry on the form list.
Authentication is required to execute this request. Please refer to Authentication for more.
{formId}| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
formId |
string |
Form identifier. |
Do not supply a request body with this method.
If successful, this method returns an empty response body.
Returns an entry of the form list.
Authentication is required to execute this request. Please refer to Authentication for more.
{formId}| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
formId |
string |
Form identifier. |
Do not supply a request body with this method.
If successful, this method returns a Form resource in the response body.
Returns entries on the form list.
Authentication is required to execute this request. Please refer to Authentication for more.
Do not supply a request body with this method.
If successful, this method returns a response body with the following structure:
Adds an entry to the form list.
Authentication is required to execute this request. Please refer to Authentication for more.
In the request body, supply a Form Resource with the following properties:
| Parameter name | Value | Description |
|---|---|---|
| Required Properties | ||
name |
string |
Name of the form. |
| Optional Properties | ||
id |
string |
Identifier of the form. |
author |
string |
Author of the form. |
description |
string |
Description of the form. |
content |
string |
Content of the form in XML. |
submitMessage |
string |
Message of the form after validation. |
fields[] |
string |
Fields of the form. |
fields[].id |
string |
Id of the fields. |
fields[].type |
string |
Type of the field. |
fields[].label |
string |
Label of the field. |
fields[].mandatory |
boolean |
If the field is mandatory. |
fields[].order |
integer |
Order number of the fields. |
fields[].key |
string |
Key of the field. |
fields[].values |
string |
Values list of the field. |
If successful, this method returns a Form resource in the response body.
Updates an entry on the form list.
Authentication is required to execute this request. Please refer to Authentication for more.
{formId}| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
formId |
string |
Form identifier. |
In the request body, supply a Form resource with the following properties:
| Parameter name | Value | Description |
|---|---|---|
| Optional Properties | ||
name |
string |
Name of the form. |
If successful, this method returns a Form resource in the response body.