Skip to main content
PATCH
Update form

Authorizations

Authorization
string
header
required

MeshQu API key passed as a bearer token: Authorization: Bearer mqu_…. Mint one in the console (Settings → API keys).

X-MeshQu-Tenant-Id
string
header
required

Tenant UUID for multi-tenant isolation. Required on authenticated routes. A missing or non-UUID value returns 400 MISSING_TENANT_ID or INVALID_TENANT_ID before API-key authentication.

Path Parameters

formId
string<uuid>
required

Form UUID

Body

application/json
scope
Available options:
policy
access_mode
Available options:
open
password
string
Required string length: 8 - 128
branding
object | null
identifier_config
object | null
is_published
boolean
policy_version
integer | null
Required range: x >= 1

Response

Default Response

form_id
string<uuid>
required
tenant_id
string<uuid>
required
policy_id
string<uuid>
required
policy_version
integer | null
required
is_frozen
boolean
required
scope
string
required
access_mode
string
required
branding
object | null
required
identifier_config
object | null
required
is_published
boolean
required
token_expires_at
string | null
required
token_max_uses
integer | null
required
token_use_count
integer
required
created_at
string
required
updated_at
string
required
token_secret
string

Token secret — only returned on create/regenerate (one-time reveal)