list

Update a list

Renames a list.

patch/v1/list/{list_id}

Request

Base URL: http://localhost:3030
URL: http://localhost:3030/v1/list/{list_id}
Auth: HTTP bearer

Path parameters

list_idstring required

The list's id, lst_....

Request body

namestring nullable

The list's name, up to 200 characters.

Response

The saved list.

object'list' required

The object's type. Always list.

idstring required

Unique identifier for the object.

namestring required

The list's name.

item_countinteger required

Number of items on the list.

created_atstring date-time required

Time at which the object was created.

updated_atstring date-time required

Time at which the object was last updated.

hrefstring required

The object's path in the API.

Example response

{
  "id": "lst_01h455vb4pex5vsknk084sn02q",
  "name": "Sites under review",
  "item_count": 12,
  "status_counts": {
    "new": 5,
    "reviewing": 4,
    "pursuing": 2,
    "passed": 1
  },
  "href": "/v1/list/lst_01h455vb4pex5vsknk084sn02q"
}

Changes

No recorded changes to this operation across all 1 revision of this API.