Skip to main content
PUT
/
api
/
v1
/
brief-forms
/
{form_id}
Update Form
curl --request PUT \
  --url https://api.example.com/api/v1/brief-forms/{form_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "schema_json": {},
  "ui_schema_json": {},
  "status": "<string>",
  "change_summary": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "slug": "<string>",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "schema_json": {},
  "ui_schema_json": {},
  "source_type": "<string>",
  "status": "<string>",
  "is_template": true,
  "current_version": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source_file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "field_count": 0
}

Documentation Index

Fetch the complete documentation index at: https://docs.aitasker.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
form_id
string<uuid>
required

Body

application/json

Update an existing form (creates a new version).

​
name
string | null
Required string length: 1 - 200
​
description
string | null
​
schema_json
Schema Json · object

Updated JSON Schema (triggers new version)

​
ui_schema_json
Ui Schema Json · object
​
status
string | null

draft | active | archived

​
change_summary
string | null

Changelog for this version

Response

Successful Response

Full form detail including schema.

​
id
string<uuid>
required
​
name
string
required
​
slug
string
required
​
user_id
string<uuid>
required
​
schema_json
Schema Json · object
required
​
ui_schema_json
Ui Schema Json · object
required
​
source_type
string
required
​
status
string
required
​
is_template
boolean
required
​
current_version
integer
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
description
string | null
​
team_id
string<uuid> | null
​
source_file_id
string<uuid> | null
​
field_count
integer
default:0