Create Form

Creates a form. Version 1 is published immediately. Omit form_elements/settings to create a minimal form, then PUT /draft and POST /publish.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Create Form Params

Create a form. Version 1 is published immediately. Omit form_elements/settings for a minimal form, then edit the draft and publish.

endings
array of objects

Alternate ending screens referenced by end_form actions.

endings
form_elements
array of objects

Ordered form elements. Types must match GET /v1/forms/field-types.

form_elements
boolean
logic
array of objects

Conditional logic rules. Combinators: and, or. Actions: jump_to, show, hide, set_variable, end_form. See GET /v1/forms/field-types.

logic
string
required
notification_emails
array of strings
notification_emails
boolean
settings
object

Complete form settings document. PUT /draft replaces this map, so round-trip the value returned by GET /v1/forms/:id.

string
boolean
tags
array of uuids
tags
variables
array of objects

Declared URL params / calculated keys for {{...}} piping.

variables
Responses

Callback
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json