Skip to main content
PUT
Update Form

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The ID of the form.

Body

application/json
name
string

Display name of the form. Omit or send empty to leave unchanged.

description
string

What the form is for. Omit or send empty to leave unchanged.

content
string

The form module source. Omit or send empty to leave unchanged.

isPublished
boolean | null

Whether the form is published. Set to true to publish the current draft.

isEnabled
boolean | null

Whether the form accepts new sessions. Set false to stop it being fillable without deleting it; its versions and published state are kept.

Response

200 - application/json

Success

data
data · object

The updated form.