Create a form

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

blocks

object[]

required

blocks.groupType

enum<string>

required

Available options:

FORM_TITLE,

TEXT,

LABEL,

TITLE,

HEADING_1,

HEADING_2,

HEADING_3,

DIVIDER,

PAGE_BREAK,

THANK_YOU_PAGE,

IMAGE,

EMBED,

EMBED_VIDEO,

EMBED_AUDIO,

QUESTION,

MULTIPLE_CHOICE,

CHECKBOXES,

DROPDOWN,

RANKING,

MATRIX,

MULTI_SELECT,

INPUT_TEXT,

INPUT_NUMBER,

INPUT_EMAIL,

INPUT_LINK,

INPUT_PHONE_NUMBER,

INPUT_DATE,

INPUT_TIME,

TEXTAREA,

FILE_UPLOAD,

LINEAR_SCALE,

RATING,

HIDDEN_FIELDS,

MULTIPLE_CHOICE_OPTION,

CHECKBOX,

DROPDOWN_OPTION,

RANKING_OPTION,

MULTI_SELECT_OPTION,

PAYMENT,

SIGNATURE,

MATRIX_ROW,

MATRIX_COLUMN,

WALLET_CONNECT,

CONDITIONAL_LOGIC,

CALCULATED_FIELDS,

CAPTCHA,

RESPONDENT_COUNTRY

blocks.groupUuid

string

required

blocks.type

enum<string>

required

Available options:

FORM_TITLE,

TEXT,

LABEL,

TITLE,

HEADING_1,

HEADING_2,

HEADING_3,

DIVIDER,

PAGE_BREAK,

THANK_YOU_PAGE,

IMAGE,

EMBED,

EMBED_VIDEO,

EMBED_AUDIO,

QUESTION,

MULTIPLE_CHOICE,

CHECKBOXES,

DROPDOWN,

RANKING,

MATRIX,

MULTI_SELECT,

INPUT_TEXT,

INPUT_NUMBER,

INPUT_EMAIL,

INPUT_LINK,

INPUT_PHONE_NUMBER,

INPUT_DATE,

INPUT_TIME,

TEXTAREA,

FILE_UPLOAD,

LINEAR_SCALE,

RATING,

HIDDEN_FIELDS,

MULTIPLE_CHOICE_OPTION,

CHECKBOX,

DROPDOWN_OPTION,

RANKING_OPTION,

MULTI_SELECT_OPTION,

PAYMENT,

SIGNATURE,

MATRIX_ROW,

MATRIX_COLUMN,

WALLET_CONNECT,

CONDITIONAL_LOGIC,

CALCULATED_FIELDS,

CAPTCHA,

RESPONDENT_COUNTRY

blocks.uuid

string

required

blocks.payload

object

status

enum<string>

required

Initial status of the form

Available options:

BLANK,

DRAFT,

PUBLISHED,

DELETED

settings

object

templateId

string

ID of the template to base the form on

workspaceId

string

ID of the workspace to create the form in. If not provided, uses the user's default workspace

Response

201 - application/json

createdAt

string

required

string

required

isClosed

boolean

required

name

string

required

numberOfSubmissions

number

required

status

enum<string>

required

Available options:

BLANK,

DRAFT,

PUBLISHED,

DELETED

updatedAt

string

required

workspaceId

string

required

payments

object[]

Getting started

Users

Forms

Form submissions

Workspaces

Webhooks

Authorizations

Body

Response