API ReferenceBoards

Update board

View as Markdown

Partial update. Omit a field to leave it unchanged. Sending tag: null untags the board; omitting it leaves the current tag alone.

Path parameters

org_idstringRequired
Organization ID
workspace_idstringRequired
Workspace ID
board_idstringRequiredformat: "uuid"

Headers

X-API-KeystringRequired
Your workspace API key.

Request

This endpoint expects an object.
namestring or nullOptional4-80 characters

New display name. Omit to leave unchanged; null is rejected.

tagstring or nullOptional4-80 characters

Replacement tag, replacing any existing one. Omit to leave unchanged; send null to untag the board.

Response

Successful Response
idstringformat: "uuid"

Board identifier, used as {board_id} in every nested route

namestring
Board display name
created_byobject
Actor that created the board
created_atdatetime
Creation time, UTC, RFC 3339
updated_byobject
Actor that last changed the board or anything on it
updated_atdatetime
Last change time, UTC, RFC 3339
tagstring or nullOptional
The board's grouping tag, or null when untagged

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error