# Rename a list

`PATCH https://evohub.io/api/v1/board/lists/{listID}`

Part of the [Board API](https://docs.evohub.io/board.md) reference · operationId `renameList`.

Renames the list. `name` is required (at most 80 characters).
`placement` is accepted and ignored; move a list with
*Move a list*.

Requires the `board:list: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

- `listID` (string, required, example `lst_2b3c4d5e6f7a48b9c0d1e2f3a4b5c6d7`): The list's ID.

## Request body (required)

Content type: `application/json`

Type: `ListRequest`

- `name` (string, required, max length 80)
- `placement` (Placement)
  - `after` (string): The ID of the item it should follow. Empty means the top.
  - `before` (string): The ID of the item it should precede. Empty means the bottom.
  - `to` (string, one of `top`, `bottom`): An end of the list. Any other value is ignored.

## Responses

### 200 — The new name.

Content type: `application/json`

Type: `object`

- `data` (object)
  - `name` (string)

### 400 — The body is not JSON for this endpoint, or carries a field it does not know (`INVALID_BODY`), or a field breaks a rule (`VALIDATION_ERROR`; the message says which).

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required, example `NOT_FOUND`)
  - `message` (string, required, example `not found`)
  - `request_id` (string)

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

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required, example `NOT_FOUND`)
  - `message` (string, required, example `not found`)
  - `request_id` (string)

### 403 — The key lacks the scope this endpoint needs (`FORBIDDEN`).

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required, example `NOT_FOUND`)
  - `message` (string, required, example `not found`)
  - `request_id` (string)

### 404 — It does not exist, or it is on a board the caller cannot see (`NOT_FOUND`).

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required, example `NOT_FOUND`)
  - `message` (string, required, example `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`

- `error` (object, required)
  - `code` (string, required, example `NOT_FOUND`)
  - `message` (string, required, example `not found`)
  - `request_id` (string)

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

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required, example `NOT_FOUND`)
  - `message` (string, required, example `not found`)
  - `request_id` (string)

## Example request

```bash
curl -X PATCH 'https://evohub.io/api/v1/board/lists/lst_2b3c4d5e6f7a48b9c0d1e2f3a4b5c6d7' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <TOKEN>' \
  -d '{
  "name": "Waiting on others"
}'
```