Documentation menu

← Lists and monitors

API reference

Update a list

PATCH/v1/list/{list_id}

Renames a list.

Parameters

path

list_idrequiredstring
The list's id, lst_....

Request body

namestring | null
The list's name, up to 200 characters.

Responses

200
list object
The saved list.
401
ProblemDetail
credential_missing, credential_invalid or credential_expired. The request has no valid credential.
403
ProblemDetail
scope_missing, person_required, api_key_not_accepted or entitlement_missing. The credential or plan does not allow this request. detail names the reason.
404
ProblemDetail
no_such_resource. No object has that id.
422
ProblemDetail
parameter_invalid, id_malformed or a cursor code. A parameter is missing or invalid. errors lists each one.
429
ProblemDetail
rate_limited. Too many requests. Retry after the Retry-After interval. Nothing is charged.

Example request

curl -X PATCH 'https://api.placestack.com/v1/list/018f4b75-6f79-7c6a-8c80-000000000001' \
  -H "Authorization: Bearer $PLACESTACK_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string"
}'

Example response

{
  "object": "list",
  "id": "lst_01h455vb4pex5vsknk084sn02q",
  "name": "Sites under review",
  "item_count": 12,
  "created_at": "2026-09-13T12:00:00Z",
  "updated_at": "2026-09-13T12:00:00Z",
  "href": "/v1/list/lst_01h455vb4pex5vsknk084sn02q"
}

Next steps

DELETE /list/{list_id}

Delete a list

Continue