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
  }
}
'
import requests

url = "https://formhug.ai/api/v1/forms/{form_token}/settings"

payload = {
    "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
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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}
  })
};

fetch('https://formhug.ai/api/v1/forms/{form_token}/settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://formhug.ai/api/v1/forms/{form_token}/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://formhug.ai/api/v1/forms/{form_token}/settings"

	payload := strings.NewReader("{\n  \"locale\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"after_submission\": {\n    \"show_message\": {\n      \"rich_text\": \"<string>\",\n      \"text\": {\n        \"title\": \"<string>\",\n        \"description\": \"<string>\"\n      }\n    },\n    \"redirect\": {\n      \"url\": \"<string>\",\n      \"fields\": [\n        \"<string>\"\n      ]\n    },\n    \"report\": {\n      \"score_based_feedbacks\": [\n        {\n          \"start_point\": 123,\n          \"end_point\": 123,\n          \"comment\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"availability\": {\n    \"manually_closed\": true,\n    \"schedule\": {\n      \"start_at\": \"2023-11-07T05:31:56Z\",\n      \"end_at\": \"2023-11-07T05:31:56Z\"\n    },\n    \"entries_limit\": 2,\n    \"show_countdown\": true,\n    \"show_form_before_open\": true\n  },\n  \"access_control\": {\n    \"access_password\": \"<string>\"\n  },\n  \"submission_options\": {\n    \"show_progress\": true,\n    \"show_field_number\": true\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://formhug.ai/api/v1/forms/{form_token}/settings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"locale\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"after_submission\": {\n    \"show_message\": {\n      \"rich_text\": \"<string>\",\n      \"text\": {\n        \"title\": \"<string>\",\n        \"description\": \"<string>\"\n      }\n    },\n    \"redirect\": {\n      \"url\": \"<string>\",\n      \"fields\": [\n        \"<string>\"\n      ]\n    },\n    \"report\": {\n      \"score_based_feedbacks\": [\n        {\n          \"start_point\": 123,\n          \"end_point\": 123,\n          \"comment\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"availability\": {\n    \"manually_closed\": true,\n    \"schedule\": {\n      \"start_at\": \"2023-11-07T05:31:56Z\",\n      \"end_at\": \"2023-11-07T05:31:56Z\"\n    },\n    \"entries_limit\": 2,\n    \"show_countdown\": true,\n    \"show_form_before_open\": true\n  },\n  \"access_control\": {\n    \"access_password\": \"<string>\"\n  },\n  \"submission_options\": {\n    \"show_progress\": true,\n    \"show_field_number\": true\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://formhug.ai/api/v1/forms/{form_token}/settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"locale\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"after_submission\": {\n    \"show_message\": {\n      \"rich_text\": \"<string>\",\n      \"text\": {\n        \"title\": \"<string>\",\n        \"description\": \"<string>\"\n      }\n    },\n    \"redirect\": {\n      \"url\": \"<string>\",\n      \"fields\": [\n        \"<string>\"\n      ]\n    },\n    \"report\": {\n      \"score_based_feedbacks\": [\n        {\n          \"start_point\": 123,\n          \"end_point\": 123,\n          \"comment\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"availability\": {\n    \"manually_closed\": true,\n    \"schedule\": {\n      \"start_at\": \"2023-11-07T05:31:56Z\",\n      \"end_at\": \"2023-11-07T05:31:56Z\"\n    },\n    \"entries_limit\": 2,\n    \"show_countdown\": true,\n    \"show_form_before_open\": true\n  },\n  \"access_control\": {\n    \"access_password\": \"<string>\"\n  },\n  \"submission_options\": {\n    \"show_progress\": true,\n    \"show_field_number\": true\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "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
    }
  }
}
{
  "error": "Name can't be blank",
  "error_details": [
    {
      "attribute": "name",
      "message": "can't be blank"
    }
  ]
}

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 July 9, 2026