v3

latestOpenAPI 3.0.1MIT2026-08-0438140196.2 KB

Update a form

Updates a form's settings, blocks, or status.

patch/forms/{formId}

Path parameters

formIdstring required

The ID of the form to update

Request body

namestring

New name for the form

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

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 updated 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