---
type: api
title: Update a list
description: **Spaces method and path for this operation:**
url: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/kibana/v8/operation/operation-updatelist
resource: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/kibana/v8/operation/operation-updatelist
products:
  - Kibana
---

# Update a list

- Server: `https://{kibana_url}`

## Paths

- `PUT` `/api/lists`
- `PUT` `/s/{space_id}/api/lists`

## Description

Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.

Update a list using the list ID. The original list is replaced, and all unspecified fields are deleted.
> info
> You cannot modify the `id` value.

## Authentication

- Api key: `Authorization: <value>`
  These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: `Authorization: ApiKey base64AccessApiKey`
- Basic: `Authorization: Basic <credentials>`

## Request body

List's properties

`application/json`

- `_version` (string) — optional
- `description` (string · format: nonempty · min length: 1) — required
  A string that does not contain only whitespace characters
- `id` (string · format: nonempty · min length: 1) — required
  A string that does not contain only whitespace characters
- `meta` (object) — optional
- `name` (string · format: nonempty · min length: 1) — required
  A string that does not contain only whitespace characters
- `version` (integer · min: 1) — optional

## Responses

#### `200`

Successful response

`application/json`

- `_version` (string)
- `@timestamp` (string · format: date-time)
- `created_at` (string · format: date-time)
- `created_by` (string)
- `description` (string · format: nonempty · min length: 1)
  A string that does not contain only whitespace characters
- `id` (string · format: nonempty · min length: 1)
  A string that does not contain only whitespace characters
- `immutable` (boolean)
- `meta` (object)
- `name` (string · format: nonempty · min length: 1)
  A string that does not contain only whitespace characters
- `tie_breaker_id` (string)
- `type` (enum)
  Values: `binary`, `boolean`, `byte`, `date`, `date_nanos`, `date_range`, `double`, `double_range`, `float`, `float_range`, `geo_point`, `geo_shape`, `half_float`, `integer`, `integer_range`, `ip`, `ip_range`, `keyword`, `long`, `long_range`, `shape`, `short`, `text`
- `updated_at` (string · format: date-time)
- `updated_by` (string)
- `version` (integer · min: 1)
#### `400`

Invalid input data response

`application/json`

One of:
- **{ error, statusCode }**
  - `error` (string)
  - `message` (string)
  - `statusCode` (integer)
- **{ status_code }**
  - `message` (string)
  - `status_code` (integer)
#### `401`

Unsuccessful authentication response

`application/json`

- `error` (string)
- `message` (string)
- `statusCode` (integer)
#### `403`

Not enough privileges response

`application/json`

- `error` (string)
- `message` (string)
- `statusCode` (integer)
#### `404`

List not found response

`application/json`

- `message` (string)
- `status_code` (integer)
#### `500`

Internal server error response

`application/json`

- `message` (string)
- `status_code` (integer)
## Code examples

#### Console

```console
PUT kbn:/api/lists
{
  "description": "string",
  "id": "string",
  "name": "string"
}
```

#### curl

```curl
curl -X PUT "${KIBANA_URL}/api/lists" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "string",
    "id": "string",
    "name": "string"
  }'
```