Skip to main content
PUT
/
forms
/
{id}
Update form
curl --request PUT \
  --url https://app.azalt.co/api/v1/forms/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "isPublic": true,
  "name": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "showOrganizationLogo": true,
  "headerBgColor": "<string>",
  "logoWidth": 123,
  "headerPaddingTop": 123,
  "headerPaddingBottom": 123,
  "settings": {
    "allowPublicSubmissionEdits": true,
    "allowPublicSubmissionSupportingDocuments": true,
    "publicSupportingDocumentsMode": "all",
    "workflowOverride": {
      "type": "DIRECT_APPROVAL"
    },
    "schedules": {
      "dataEntry": {
        "period": "MONTHLY",
        "dueDay": 14,
        "reminders": {
          "enabled": true,
          "offsets": [
            123
          ]
        }
      },
      "approval": {
        "period": "MONTHLY",
        "dueDay": 14,
        "reminders": {
          "enabled": true,
          "offsets": [
            123
          ]
        }
      }
    }
  },
  "metadata": {}
}
'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "isPublic": true
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Body

application/json
isPublic
enum<boolean>
Available options:
true,
false
name
string
description
string | null
tags
string[]
headerBgColor
string | null
logoWidth
number | null
headerPaddingTop
number | null
headerPaddingBottom
number | null
settings
object
metadata
object

Response

Successful response

id
string
required
name
string
required
description
string | null
required
isPublic
boolean
required