Skip to content

BoardsApi

Access through client.Boards.

Update

Task<Board> UpdateAsync(
    string boardId,
    UpdateBoardRequest request,
    OkatanaRequestOptions? options = null,
    CancellationToken cancellationToken = default)

Route: PATCH /boards/{board}. Scope: boards:write.

The request can update name, nullable color, nullable WIP limit, done state, and hidden state. Assigning Color = null or WipLimit = null sends explicit JSON null; leaving the property unset omits it.

Soft-delete

Task DeleteAsync(
    string boardId,
    DeleteBoardRequest? request = null, ...)

Route: DELETE /boards/{board}. Scope: boards:write.

If the board still contains tickets, the API may require MoveToBoardId:

await client.Boards.DeleteAsync(oldBoard.Id,
    new DeleteBoardRequest { MoveToBoardId = replacement.Id });

The server can reject the operation with 422 if the target is invalid or a WIP rule prevents the move.