Update form
curl --request PATCH \
--url https://api.meshqu.com/v1/forms/{formId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-MeshQu-Tenant-Id: <api-key>' \
--data '
{
"scope": "policy",
"access_mode": "open",
"password": "<string>",
"branding": {
"label": "<string>",
"description": "<string>",
"logo_url": "<string>"
},
"identifier_config": {
"label": "<string>",
"placeholder": "<string>",
"helper_text": "<string>"
},
"is_published": true,
"policy_version": 2
}
'import requests
url = "https://api.meshqu.com/v1/forms/{formId}"
payload = {
"scope": "policy",
"access_mode": "open",
"password": "<string>",
"branding": {
"label": "<string>",
"description": "<string>",
"logo_url": "<string>"
},
"identifier_config": {
"label": "<string>",
"placeholder": "<string>",
"helper_text": "<string>"
},
"is_published": True,
"policy_version": 2
}
headers = {
"Authorization": "Bearer <token>",
"X-MeshQu-Tenant-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'X-MeshQu-Tenant-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
scope: 'policy',
access_mode: 'open',
password: '<string>',
branding: {label: '<string>', description: '<string>', logo_url: '<string>'},
identifier_config: {label: '<string>', placeholder: '<string>', helper_text: '<string>'},
is_published: true,
policy_version: 2
})
};
fetch('https://api.meshqu.com/v1/forms/{formId}', 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://api.meshqu.com/v1/forms/{formId}",
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([
'scope' => 'policy',
'access_mode' => 'open',
'password' => '<string>',
'branding' => [
'label' => '<string>',
'description' => '<string>',
'logo_url' => '<string>'
],
'identifier_config' => [
'label' => '<string>',
'placeholder' => '<string>',
'helper_text' => '<string>'
],
'is_published' => true,
'policy_version' => 2
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-MeshQu-Tenant-Id: <api-key>"
],
]);
$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://api.meshqu.com/v1/forms/{formId}"
payload := strings.NewReader("{\n \"scope\": \"policy\",\n \"access_mode\": \"open\",\n \"password\": \"<string>\",\n \"branding\": {\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"logo_url\": \"<string>\"\n },\n \"identifier_config\": {\n \"label\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"helper_text\": \"<string>\"\n },\n \"is_published\": true,\n \"policy_version\": 2\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-MeshQu-Tenant-Id", "<api-key>")
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://api.meshqu.com/v1/forms/{formId}")
.header("Authorization", "Bearer <token>")
.header("X-MeshQu-Tenant-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"scope\": \"policy\",\n \"access_mode\": \"open\",\n \"password\": \"<string>\",\n \"branding\": {\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"logo_url\": \"<string>\"\n },\n \"identifier_config\": {\n \"label\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"helper_text\": \"<string>\"\n },\n \"is_published\": true,\n \"policy_version\": 2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.meshqu.com/v1/forms/{formId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-MeshQu-Tenant-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scope\": \"policy\",\n \"access_mode\": \"open\",\n \"password\": \"<string>\",\n \"branding\": {\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"logo_url\": \"<string>\"\n },\n \"identifier_config\": {\n \"label\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"helper_text\": \"<string>\"\n },\n \"is_published\": true,\n \"policy_version\": 2\n}"
response = http.request(request)
puts response.read_body{
"form_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"policy_version": 123,
"is_frozen": true,
"scope": "<string>",
"access_mode": "<string>",
"branding": {
"label": "<string>",
"description": "<string>",
"logo_url": "<string>"
},
"identifier_config": {
"label": "<string>",
"placeholder": "<string>",
"helper_text": "<string>"
},
"is_published": true,
"token_expires_at": "<string>",
"token_max_uses": 123,
"token_use_count": 123,
"created_at": "<string>",
"updated_at": "<string>",
"token_secret": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"correlation_id": "<string>"
}Forms
Update form
Updates form settings (access mode, branding, etc.).
PATCH
/
v1
/
forms
/
{formId}
Update form
curl --request PATCH \
--url https://api.meshqu.com/v1/forms/{formId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-MeshQu-Tenant-Id: <api-key>' \
--data '
{
"scope": "policy",
"access_mode": "open",
"password": "<string>",
"branding": {
"label": "<string>",
"description": "<string>",
"logo_url": "<string>"
},
"identifier_config": {
"label": "<string>",
"placeholder": "<string>",
"helper_text": "<string>"
},
"is_published": true,
"policy_version": 2
}
'import requests
url = "https://api.meshqu.com/v1/forms/{formId}"
payload = {
"scope": "policy",
"access_mode": "open",
"password": "<string>",
"branding": {
"label": "<string>",
"description": "<string>",
"logo_url": "<string>"
},
"identifier_config": {
"label": "<string>",
"placeholder": "<string>",
"helper_text": "<string>"
},
"is_published": True,
"policy_version": 2
}
headers = {
"Authorization": "Bearer <token>",
"X-MeshQu-Tenant-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'X-MeshQu-Tenant-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
scope: 'policy',
access_mode: 'open',
password: '<string>',
branding: {label: '<string>', description: '<string>', logo_url: '<string>'},
identifier_config: {label: '<string>', placeholder: '<string>', helper_text: '<string>'},
is_published: true,
policy_version: 2
})
};
fetch('https://api.meshqu.com/v1/forms/{formId}', 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://api.meshqu.com/v1/forms/{formId}",
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([
'scope' => 'policy',
'access_mode' => 'open',
'password' => '<string>',
'branding' => [
'label' => '<string>',
'description' => '<string>',
'logo_url' => '<string>'
],
'identifier_config' => [
'label' => '<string>',
'placeholder' => '<string>',
'helper_text' => '<string>'
],
'is_published' => true,
'policy_version' => 2
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-MeshQu-Tenant-Id: <api-key>"
],
]);
$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://api.meshqu.com/v1/forms/{formId}"
payload := strings.NewReader("{\n \"scope\": \"policy\",\n \"access_mode\": \"open\",\n \"password\": \"<string>\",\n \"branding\": {\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"logo_url\": \"<string>\"\n },\n \"identifier_config\": {\n \"label\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"helper_text\": \"<string>\"\n },\n \"is_published\": true,\n \"policy_version\": 2\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-MeshQu-Tenant-Id", "<api-key>")
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://api.meshqu.com/v1/forms/{formId}")
.header("Authorization", "Bearer <token>")
.header("X-MeshQu-Tenant-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"scope\": \"policy\",\n \"access_mode\": \"open\",\n \"password\": \"<string>\",\n \"branding\": {\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"logo_url\": \"<string>\"\n },\n \"identifier_config\": {\n \"label\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"helper_text\": \"<string>\"\n },\n \"is_published\": true,\n \"policy_version\": 2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.meshqu.com/v1/forms/{formId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-MeshQu-Tenant-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scope\": \"policy\",\n \"access_mode\": \"open\",\n \"password\": \"<string>\",\n \"branding\": {\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"logo_url\": \"<string>\"\n },\n \"identifier_config\": {\n \"label\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"helper_text\": \"<string>\"\n },\n \"is_published\": true,\n \"policy_version\": 2\n}"
response = http.request(request)
puts response.read_body{
"form_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"policy_version": 123,
"is_frozen": true,
"scope": "<string>",
"access_mode": "<string>",
"branding": {
"label": "<string>",
"description": "<string>",
"logo_url": "<string>"
},
"identifier_config": {
"label": "<string>",
"placeholder": "<string>",
"helper_text": "<string>"
},
"is_published": true,
"token_expires_at": "<string>",
"token_max_uses": 123,
"token_use_count": 123,
"created_at": "<string>",
"updated_at": "<string>",
"token_secret": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"correlation_id": "<string>"
}Authorizations
MeshQu API key passed as a bearer token: Authorization: Bearer mqu_…. Mint one in the console (Settings → API keys).
Tenant UUID for multi-tenant isolation. Required on all authenticated routes — validated before authentication (middleware/tenant.ts), so a missing or non-UUID header returns 400 (MISSING_TENANT_ID / INVALID_TENANT_ID) before the API key is checked.
Path Parameters
Form UUID
Body
application/json
Available options:
policy access_mode
Option 1 · enum<string>Option 2 · enum<string>Option 3 · enum<string>Option 4 · enum<string>
Available options:
open Required string length:
8 - 128Show child attributes
Show child attributes
Show child attributes
Show child attributes
Required range:
x >= 1Response
Default Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Token secret — only returned on create/regenerate (one-time reveal)
⌘I