Skip to main content
PATCH
Error

Authorizations

fastapiusersauth
string
cookie
required

Path Parameters

form_id
string<uuid>
required
workspace_id
string<uuid>
required

Body

application/json
status
enum<string> | null

Whether a form accepts submissions.

Available options:
online,
offline
config
FormConfig · object | null

Replaces the whole config.

base_config_version
string | null

The config_version the edit started from. If set and the saved config has changed since, the update is rejected with form_changed.

Response

Successful Response

id
string<uuid>
required
workspace_id
string<uuid>
required
workflow_id
string
required
Pattern: wf_[0-9a-zA-Z]+
workflow_title
string
required
status
enum<string>
required

Whether a form accepts submissions.

Available options:
online,
offline
config
FormConfig · object
required

Presentation layer of a form. The workflow input schema supplies the rest.

config_version
string
required

Version of the saved config.

issues
FormIssue · object[]
required
url
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
workflow_version
integer | null

Published workflow version the inputs come from, if any.

counts
FormCounts · object | null

Null without form:submission:read.