Skip to main content
PATCH
Update board identity fields

Authorizations

x-token
string
header
required

Headers

x-company-id
string

Required with a partner bearer token (board-admin): the company that owns the board. Standard boards such as unit share one board UUID across companies, so the board is looked up by UUID within this company. companyId in the request body or query string is also accepted. A partner request without a company is rejected with MISSING_DATA (400), and a board the company does not own is BOARD_NOT_FOUND (404). Ignored for API keys, whose company comes from the key.

Path Parameters

boardId
string
required

Body

application/json
name
string
cardName
string
color
string
Example:

"#1ec968"

icon
string
Example:

"fas fa-wrench"

description
string
shortCode
string

Response

The board's identity fields after the update.

data
object