Skip to main content
PATCH
Update workspace

Authorizations

Authorization
string
header
required

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

Idempotency-Key
string

Path Parameters

id
string<uuid>
required

Body

application/json
name
null | string
required
description
null | string
required
icon
null | string
required
color
null | string
required
status
null | enum<string>
required
Available options:
Active,
Archived
expectedVersion
required

Response

OK

id
string<uuid>
required
tenantId
string<uuid>
required
name
string
required
type
string
required
description
null | string
required
icon
null | string
required
color
null | string
required
status
enum<string>
required
Available options:
Active,
Archived
version
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
createdByMemberId
string<uuid>
required