Update a list

Auth

Update a list using the list ID. The original list is replaced, and all unspecified fields are deleted.

Note

You cannot modify the id value.

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

List's properties

_version string
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
name string · format: nonempty · min length: 1 required: A string that does not contain only whitespace characters
version integer · min: 1

Successful response

application/json

_version string
@timestamp string · format: date-time
created_at string · format: date-time required
created_by string required
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
immutable boolean required
meta object
name string · format: nonempty · min length: 1 required: A string that does not contain only whitespace characters
tie_breaker_id string required
type enum required: Values: binary boolean byte date date_nanos date_range double double_range float float_range geo_point geo_shape
updated_at string · format: date-time required
updated_by string required
version integer · min: 1 required

Invalid input data response

application/json

One of:

Unsuccessful authentication response

application/json

Not enough privileges response

application/json

List not found response

application/json

Internal server error response

application/json