Sign in

v3

latestOpenAPI 3.0.1MIT2026-08-0438140196.2 KB

Create a new form

Creates a new form, optionally based on a template or within a specific workspace.

post/forms

Request body

workspaceIdstring

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

templateIdstring

ID of the template to base the form on

folderIdstring

ID of the folder to place the form in. Must belong to the target workspace.

status'BLANK' | 'DRAFT' | 'PUBLISHED' required

Deleting a form is done through DELETE /forms/{formId}, which moves it to the trash so it can be restored.

Example request

{
  "blocks": [
    {
      "payload": {
        "allowedFiles": {
          "image/*": [
            ".png",
            ".jpg",
            ".gif"
          ],
          "application/*": [
            ".pdf"
          ]
        }
      }
    }
  ]
}

Response

Form created successfully

idstring required
namestring required
workspaceIdstring required
status'BLANK' | 'DRAFT' | 'PUBLISHED' required

Deleting a form is done through DELETE /forms/{formId}, which moves it to the trash so it can be restored.

numberOfSubmissionsnumber required
isClosedboolean required
createdAtstring date-time required
updatedAtstring date-time required