FormsCreate a form

Create a form

Needs: Forms, Read-write

Creates a draft form with steps, fields, conditional visibility, routing, settings, and incident, prospect or client pre-fill setup, checked with the form builder's rules. Responses are assigned to the organisation owner by default. The form is not published until you publish it.

Note: The response can also include notes about adjustments made, and issues that still need fixing before the form can be published. A field is {type, label, ...settings}, and you can set your own key for it so later conditions can refer to it.

curl -X POST "https://app.imploy.com.au/api/integrations/v1/forms" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "name": "Visit feedback",
  "description": "Collect feedback after a visit.",
  "tags": [
    "Feedback"
  ],
  "steps": [
    {
      "title": "Details",
      "fields": [
        {
          "type": "text",
          "label": "Client name",
          "required": true
        },
        {
          "type": "select",
          "label": "Service",
          "options": [
            "Support",
            "Transport"
          ]
        }
      ]
    }
  ]
}'
{
  "created": 14,
  "id": 14,
  "name": "Visit feedback",
  "description": "Collect feedback after a visit.",
  "published": "off",
  "url": null,
  "settings": {
    "allow_step_navigation": false,
    "show_step_numbers": true,
    "submit_button_text": "Submit"
  }
}
POST
/forms
POST
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.
Content-Typestring
Required

The media type of the request body

Options: application/json
namestring
Required

The form name, up to 255 characters.

descriptionstring

What the form is for.

tagsarray

Tag names. Colours are not set unless you send {name, color}.

stepsarray

Steps in order. Each has a title, an optional key, a list of fields, and optional routing rules. Defaults to one empty step.

settingsobject

The same keys as update_settings in the edit endpoint.

incidentobject

The same as set_incident in the edit endpoint.

prospectobject

The same as set_prospect in the edit endpoint.

client_prefillobject

The same as set_client_prefill in the edit endpoint.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

Body

application/json
namestring
Required

The form name, up to 255 characters.

descriptionstring

What the form is for.

tagsarray

Tag names. Colours are not set unless you send {name, color}.

stepsarray

Steps in order. Each has a title, an optional key, a list of fields, and optional routing rules. Defaults to one empty step.

settingsobject

The same keys as update_settings in the edit endpoint.

incidentobject

The same as set_incident in the edit endpoint.

prospectobject

The same as set_prospect in the edit endpoint.

client_prefillobject

The same as set_client_prefill in the edit endpoint.

Responses