Skip to main content
POST
Create a form

Authorizations

Authorization
string
header
required

Bearer token authentication

Headers

Idempotency-Key
string

Optional client-chosen key, 1 to 255 characters with at least one that is not whitespace; a blank key answers 422. A retry of the same request with the same key from the same company answers with the record the first request created instead of creating another, even when the first response was lost. The same key sent with a different request, or by a different user or credential, answers 422.

Required string length: 1 - 255
Pattern: \S

Body

application/json

The new form. Send its fields inside a form object, for example {"form": {"title": "Enrollment details", "form_type": "post_purchase"}}. The server reads only the form object; it accepts the same fields as Update a form, and title is required.

title

Title of the form. Required. Send it as form.title.

description

Description of the form. Send it as form.description.

Response

object | null

Success, or the form an earlier request with the same Idempotency-Key created

message

Confirmation message, such as Form created successfully.

form
object | null

The form as saved.