Skip to navigation

PM · Boards · Update board title, description, access level, or config

View as Markdown

Partial update (PATCH) for a board. All fields optional — send only what you want to change. Updatable fields: title, description, access, extra (arbitrary JSON config merged into the board’s _config).

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

board_idstringRequired
Board UUID or slug.

Headers

OrganizationstringOptional

Workspace (organization) ID the request is scoped to.

SpacestringOptional

Optional sub-space ID for further scoping inside the workspace.

Request

This endpoint expects an object.
titlestringOptional<=2048 characters
descriptionstringOptional
accessintegerOptional

0=PRIVATE, 1=PROTECTED, 2=PUBLIC.

extramap from strings to anyOptional

Free-form board configuration (merged into _config).

Response

Board updated.