Create a new form

Changed on

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

post/forms

Request

  • Base URL
    https://api.tally.so
  • URL
    https://api.tally.so/forms
  • Auth
    HTTP bearer

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

Changes

    • breaking

      request property / was restricted to a list of enum values

    • info

      added the new af enum value to the request property /

    • info

      added the new ar enum value to the request property /

    • info

      added the new bg enum value to the request property /

    • info

      added the new bn enum value to the request property /

    • info

      added the new ca enum value to the request property /

    • info

      added the new cs enum value to the request property /

    • info

      added the new da enum value to the request property /

    • info

      added the new de enum value to the request property /

    • info

      added the new el enum value to the request property /

    • info

      added the new en enum value to the request property /

    • info

      added the new es enum value to the request property /

    • info

      added the new es-MX enum value to the request property /

    • info

      added the new et enum value to the request property /

    • info

      added the new eu enum value to the request property /

    • info

      added the new fa enum value to the request property /

    • info

      added the new fi enum value to the request property /

    • info

      added the new fil enum value to the request property /

    • info

      added the new fo enum value to the request property /

    • info

      added the new fr enum value to the request property /

    • info

      added the new ga enum value to the request property /

    • info

      added the new he enum value to the request property /

    • info

      added the new hi enum value to the request property /

    • info

      added the new hr enum value to the request property /

    • info

      added the new hu enum value to the request property /

    • info

      added the new id enum value to the request property /

    • info

      added the new is enum value to the request property /

    • info

      added the new it enum value to the request property /

    • info

      added the new ja enum value to the request property /

    • info

      added the new ka enum value to the request property /

    • info

      added the new kl enum value to the request property /

    • info

      added the new ko enum value to the request property /

    • info

      added the new lt enum value to the request property /

    • info

      added the new lv enum value to the request property /

    • info

      added the new mk enum value to the request property /

    • info

      added the new ms enum value to the request property /

    • info

      added the new nl enum value to the request property /

    • info

      added the new no enum value to the request property /

    • info

      added the new pl enum value to the request property /

    • info

      added the new pt enum value to the request property /

    • info

      added the new pt-BR enum value to the request property /

    • info

      added the new ro enum value to the request property /

    • info

      added the new ru enum value to the request property /

    • info

      added the new si enum value to the request property /

    • info

      added the new sk enum value to the request property /

    • info

      added the new sl enum value to the request property /

    • info

      added the new sq enum value to the request property /

    • info

      added the new sr enum value to the request property /

    • info

      added the new sv enum value to the request property /

    • info

      added the new ta enum value to the request property /

    • info

      added the new th enum value to the request property /

    • info

      added the new tr enum value to the request property /

    • info

      added the new uk enum value to the request property /

    • info

      added the new undefined enum value to the request property /

    • info

      added the new uz enum value to the request property /

    • info

      added the new vi enum value to the request property /

    • info

      added the new yo enum value to the request property /

    • info

      added the new zh-CN enum value to the request property /

    • info

      added the new zh-TW enum value to the request property /

    • info

      the request property /////////// became optional