Skip to main content
PATCH
Update widget

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

AD-5 idempotency: a repeated mutation with the same key replays the prior result (no double-apply).

Path Parameters

id
string<uuid>
required

Body

application/json
kind
null | string
sourceBoardIds
null | string<uuid>[]
position
groupByColumnId
null | string
filters
null | object[]
metric
null | object
title
null | string
columns
null | string[]
rowLimit

Response

OK

id
string<uuid>
required
tenantId
string<uuid>
required
dashboardId
string<uuid>
required
position
required
kind
enum<string>
required
Available options:
Count,
Chart,
Table
sourceBoardIds
string<uuid>[]
required
groupByColumnId
null | string
required
filters
object[]
required
metric
null | object
title
null | string
columns
null | string[]
rowLimit
effectiveMetric
object