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.

quiz scores the form when is_quiz is true. Public submit includes quiz.score and quiz.max_score only when show_score_to_respondent is true, and quiz.questions only when show_feedback_to_respondent is true. shuffle_questions applies only when the form has no logic rules and no answer or step dependencies. Correct answers stay on this authoring payload and are removed from the public form, response listings, and webhooks.

collection holds progress and confirmation settings. Subject, body, format, and design are authoring-only. The public form returns needs_confirmation_email when the respondent must supply an address. Submit and finalize accept confirmation_email for that case.

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