# Rename or move a board

`PATCH https://evohub.io/api/v1/retro/boards/{boardID}`

Part of the [Retro API](https://docs.evohub.io/retro.md) reference · operationId `updateRetroBoard`.

Changes a board's name and description, and optionally its team and
visibility. Works on a closed board too.

- `name` is required on every call, at most 200 characters.
- `description` is replaced by what you send; leaving it out clears it.
- `team_id`: left out, the board stays where it is; `""` moves it to
  the whole organization; a team must be one the caller is in.
- `visibility`: left out, it is kept. A `team` board needs a team.

Requires the `retro:board:write` scope.

## Authorization

Any one of:

- `bearerKey`
- `headerKey`

Where:

- `bearerKey`: HTTP Bearer — An EvoHub API key (`evohub_…`) as a bearer token.
- `headerKey`: API key in the header `X-API-Key` — An EvoHub API key (`evohub_…`).

## Path parameters

- `boardID` (string, required, example `brd_3f9a1c7e2b8d4a60`): The board's ID.

## Request body (required)

Content type: `application/json`

Type: `UpdateBoardRequest`

- `name` (string, required, max length 200)
- `description` (string): Replaces the description; left out, it is cleared.
- `team_id` (string): Left out keeps the board's team; `""` moves it to the whole organization.
- `visibility` (Visibility, one of `org`, `team`, `private`)

## Responses

### 200 — The board was changed.

Content type: `application/json`

Type: `IdEnvelope`

- `success` (boolean)
- `data` (object)
  - `id` (string)

### 400 — The body is not JSON (`INVALID_BODY`), `name` is missing or blank (`MISSING_NAME`), `name` is over 200 characters (`VALIDATION_FAILED`), `visibility` is unknown (`INVALID_VISIBILITY`), or a `team` board would have no team (`TEAM_REQUIRED`).

Content type: `application/json`

Type: `Error | ValidationFailed`

- One of:
  - Error
    - `success` (boolean, value `false`): Sent by Retro itself; refusals before the request reaches Retro (401, 429) carry only `error`.
    - `error` (object, required)
      - `code` (string, required, example `NOT_FOUND`)
      - `message` (string, required, example `board not found`)
      - `request_id` (string)
  - ValidationFailed
    - `success` (boolean, value `false`)
    - `error` (object, required)
      - `code` (string, required, value `VALIDATION_FAILED`)
      - `message` (string, required)
      - `details` (array of object, required)
        - `field` (string)
        - `message` (string)
      - `request_id` (string)

### 401 — No API key was sent, or it is unknown, revoked or expired (`UNAUTHORIZED`).

Content type: `application/json`

Type: `Error`

- `success` (boolean, value `false`): Sent by Retro itself; refusals before the request reaches Retro (401, 429) carry only `error`.
- `error` (object, required)
  - `code` (string, required, example `NOT_FOUND`)
  - `message` (string, required, example `board not found`)
  - `request_id` (string)

### 403 — The key lacks `retro:board:write` (`FORBIDDEN`), or `team_id` names a team the caller is not in (`NOT_IN_TEAM`).

Content type: `application/json`

Type: `Error`

- `success` (boolean, value `false`): Sent by Retro itself; refusals before the request reaches Retro (401, 429) carry only `error`.
- `error` (object, required)
  - `code` (string, required, example `NOT_FOUND`)
  - `message` (string, required, example `board not found`)
  - `request_id` (string)

### 404 — The board does not exist, or the caller cannot see it (`NOT_FOUND`).

Content type: `application/json`

Type: `Error`

- `success` (boolean, value `false`): Sent by Retro itself; refusals before the request reaches Retro (401, 429) carry only `error`.
- `error` (object, required)
  - `code` (string, required, example `NOT_FOUND`)
  - `message` (string, required, example `board not found`)
  - `request_id` (string)

### 429 — Too many requests (`RATE_LIMITED`). Wait for `Retry-After` seconds.

Headers:

- `Retry-After` (integer): Seconds to wait before retrying.

Content type: `application/json`

Type: `Error`

- `success` (boolean, value `false`): Sent by Retro itself; refusals before the request reaches Retro (401, 429) carry only `error`.
- `error` (object, required)
  - `code` (string, required, example `NOT_FOUND`)
  - `message` (string, required, example `board not found`)
  - `request_id` (string)

### 500 — Something went wrong on EvoHub's side (`INTERNAL_ERROR`). Retry later.

Content type: `application/json`

Type: `Error`

- `success` (boolean, value `false`): Sent by Retro itself; refusals before the request reaches Retro (401, 429) carry only `error`.
- `error` (object, required)
  - `code` (string, required, example `NOT_FOUND`)
  - `message` (string, required, example `board not found`)
  - `request_id` (string)

## Example request

```bash
curl -X PATCH 'https://evohub.io/api/v1/retro/boards/brd_3f9a1c7e2b8d4a60' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <TOKEN>' \
  -d '{
  "name": "Sprint 42 retrospective",
  "description": "What went well and what to change after sprint 42"
}'
```