Update form
curl --request PATCH \
--url https://boardy.worksong.ai/v1/boards/{boardId}/forms/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"fields": [
{
"label": "<string>",
"columnId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"columnType": "<string>",
"required": true
}
],
"description": "<string>"
}
'import requests
url = "https://boardy.worksong.ai/v1/boards/{boardId}/forms/{id}"
payload = {
"title": "<string>",
"fields": [
{
"label": "<string>",
"columnId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"columnType": "<string>",
"required": True
}
],
"description": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
fields: [
{
label: '<string>',
columnId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
columnType: '<string>',
required: true
}
],
description: '<string>'
})
};
fetch('https://boardy.worksong.ai/v1/boards/{boardId}/forms/{id}', 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://boardy.worksong.ai/v1/boards/{boardId}/forms/{id}",
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([
'title' => '<string>',
'fields' => [
[
'label' => '<string>',
'columnId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'columnType' => '<string>',
'required' => true
]
],
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://boardy.worksong.ai/v1/boards/{boardId}/forms/{id}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"fields\": [\n {\n \"label\": \"<string>\",\n \"columnId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"columnType\": \"<string>\",\n \"required\": true\n }\n ],\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://boardy.worksong.ai/v1/boards/{boardId}/forms/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"fields\": [\n {\n \"label\": \"<string>\",\n \"columnId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"columnType\": \"<string>\",\n \"required\": true\n }\n ],\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://boardy.worksong.ai/v1/boards/{boardId}/forms/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"fields\": [\n {\n \"label\": \"<string>\",\n \"columnId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"columnType\": \"<string>\",\n \"required\": true\n }\n ],\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"boardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"intakeMemberId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fields": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"columnId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"columnType": "<string>",
"required": true,
"position": 123
}
],
"published": false,
"isPublic": false,
"description": "<string>",
"config": {
"positionsBoardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"submitButtonLabel": "<string>",
"successMessage": "<string>",
"hiddenDefaults": {}
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Boards
Update form
PATCH
/
v1
/
boards
/
{boardId}
/
forms
/
{id}
Update form
curl --request PATCH \
--url https://boardy.worksong.ai/v1/boards/{boardId}/forms/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"fields": [
{
"label": "<string>",
"columnId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"columnType": "<string>",
"required": true
}
],
"description": "<string>"
}
'import requests
url = "https://boardy.worksong.ai/v1/boards/{boardId}/forms/{id}"
payload = {
"title": "<string>",
"fields": [
{
"label": "<string>",
"columnId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"columnType": "<string>",
"required": True
}
],
"description": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
fields: [
{
label: '<string>',
columnId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
columnType: '<string>',
required: true
}
],
description: '<string>'
})
};
fetch('https://boardy.worksong.ai/v1/boards/{boardId}/forms/{id}', 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://boardy.worksong.ai/v1/boards/{boardId}/forms/{id}",
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([
'title' => '<string>',
'fields' => [
[
'label' => '<string>',
'columnId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'columnType' => '<string>',
'required' => true
]
],
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://boardy.worksong.ai/v1/boards/{boardId}/forms/{id}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"fields\": [\n {\n \"label\": \"<string>\",\n \"columnId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"columnType\": \"<string>\",\n \"required\": true\n }\n ],\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://boardy.worksong.ai/v1/boards/{boardId}/forms/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"fields\": [\n {\n \"label\": \"<string>\",\n \"columnId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"columnType\": \"<string>\",\n \"required\": true\n }\n ],\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://boardy.worksong.ai/v1/boards/{boardId}/forms/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"fields\": [\n {\n \"label\": \"<string>\",\n \"columnId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"columnType\": \"<string>\",\n \"required\": true\n }\n ],\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"boardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"intakeMemberId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fields": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"columnId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"columnType": "<string>",
"required": true,
"position": 123
}
],
"published": false,
"isPublic": false,
"description": "<string>",
"config": {
"positionsBoardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"submitButtonLabel": "<string>",
"successMessage": "<string>",
"hiddenDefaults": {}
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Authorizations
clerkSessionapiToken
Clerk session JWT (deployments with Clerk auth) — validated per request (issuer + signature + lifetime + authorized-party). The internal Boardy tenant/member are resolved from the token's ACTIVE Clerk organization (org_id) → the Boardy tenant it maps to → this user's member in that tenant (#356). A token with no active organization is rejected; production never trusts spoofable X-Tenant-Id/X-Member-Id headers. The same normalized context backs the SPA, this OpenAPI surface, and MCP.
Headers
AD-5 idempotency: a repeated mutation with the same key replays the prior result (no double-apply).
Body
application/json
Response
OK
Show child attributes
Show child attributes
Show child attributes
Show child attributes