Skip to main content
PATCH
/
api
/
v1
/
forms
/
{form_token}
/
settings
Update form settings
curl --request PATCH \
  --url https://formhug.ai/api/v1/forms/{form_token}/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "locale": "<string>",
  "timezone": "<string>",
  "after_submission": {
    "show_message": {
      "rich_text": "<string>",
      "text": {
        "title": "<string>",
        "description": "<string>"
      }
    },
    "redirect": {
      "url": "<string>",
      "fields": [
        "<string>"
      ]
    },
    "report": {
      "score_based_feedbacks": [
        {
          "start_point": 123,
          "end_point": 123,
          "comment": "<string>"
        }
      ]
    }
  },
  "availability": {
    "manually_closed": true,
    "schedule": {
      "start_at": "2023-11-07T05:31:56Z",
      "end_at": "2023-11-07T05:31:56Z"
    },
    "entries_limit": 2,
    "show_countdown": true,
    "show_form_before_open": true
  },
  "access_control": {
    "access_password": "<string>"
  },
  "submission_options": {
    "show_progress": true,
    "show_field_number": true
  }
}
'
{
  "data": {
    "locale": "<string>",
    "timezone": "<string>",
    "after_submission": {
      "show_message": {
        "rich_text": "<string>",
        "text": {
          "title": "<string>",
          "description": "<string>"
        }
      },
      "redirect": {
        "url": "<string>",
        "fields": [
          "<string>"
        ]
      },
      "report": {
        "score_based_feedbacks": [
          {
            "start_point": 123,
            "end_point": 123,
            "comment": "<string>"
          }
        ]
      }
    },
    "availability": {
      "manually_closed": true,
      "schedule": {
        "start_at": "2023-11-07T05:31:56Z",
        "end_at": "2023-11-07T05:31:56Z"
      },
      "entries_limit": 2,
      "show_countdown": true,
      "show_form_before_open": true
    },
    "access_control": {
      "access_password": "<string>"
    },
    "submission_options": {
      "show_progress": true,
      "show_field_number": true
    }
  }
}

Authorizations

​
Authorization
string
header
required

Personal Access Token prefixed with fh_. Sent as Authorization: Bearer fh_xxx. The scope required by each endpoint is listed in that endpoint's description.

Path Parameters

​
form_token
string
required

Form token

Body

application/json

PATCH body. All keys are optional; only the groups (and within them, the fields) present in the payload are updated. null clears the corresponding feature.

​
locale
string | null
​
timezone
string | null
​
after_submission
object
​
availability
object
​
access_control
object
​
submission_options
object

Response

Updated

​
data
object
required
Last modified on June 2, 2026