lists
Edit a static List
PUT /v1/lists/{id}
Auth required
api.lists.manage
Edits a List's display name and description. On writes, {id} resolves
as a UUID or, failing that, as the List's org-unique key. key and
source are immutable (a key in the body is ignored). Git-backed
Lists are read-only here (409 conflict) — edit them in the connected
repository.
Path parameters
id string required The List's UUID or, when the value does not parse as a UUID, its org-unique key. Unknown handles read as 404 not_found.
Request body
Content type: application/json
{
"name": "string",
"key": "string",
"description": "string"
}Responses
200 The updated List application/json
401 Missing, malformed, or unknown API key application/problem+json
403 Key lacks the required scope or plan limit violated application/problem+json
404 Resource not found application/problem+json
409 The mutation is rejected by a state rule rather than a bad request — e.g.
editing a git-backed (read-only) definition. The
code is conflict.
application/problem+json 422 Query parameter or path value failed validation application/problem+json
429 Per-org rate limit exceeded application/problem+json
500 Unexpected server-side failure. The
code is internal_error. The
request_id field can be quoted to SendOps support to investigate.
application/problem+json