StatusGator Octri Preview
PATCH/boards/{id}

Update a board

Updates a board's name, its assigned organization users, or both. Supply the board fields you want to change in board; passing an empty user_ids array removes all user assignments.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
idstringrequired
The public ID of the board to update.

Board fields to update; include the fields you want to change in the board object.

boardobjectoptional
The board settings object containing the name or organization user assignments to update.

4 status codes
200Returns the updated board, including its ID, name, public token, and creation and update timestamps.
dataobjectoptional
successbooleanoptional
401Returned when the request is unauthenticated.
403Returned when the request uses a read-only token.
404Returned when no board exists with the given ID.

Error handling

A 401 is returned when the request is unauthenticated. A 403 is returned when the request uses a read-only token. A 404 is returned when the id path parameter does not identify an existing board.