Edit a static List
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 required key string optional Optional on create — the org-unique slug (lowercase letters, digits, hyphen, underscore; starts with a letter; up to 63 chars). Defaults to a slug of the name. Ignored on edit.
description string optional Responses
Errors follow the RFC 7807 problem format — see the error reference.
id string<uuid> required name string required key string required Org-unique slug, stable across renames.
description string required source string enum required How the List was created.
One of: api, ui, import, topic_export
member_count integer<int64> required Cached count of current members.
origin string enum required Where the definition is authored. managed Lists are editable via this API; git Lists are synced from a connected repository and read-only here (the repo wins).
One of: managed, git
source_path string optional Repo-relative list-schema file the definition was synced from. Present only for git-backed Lists.
status string enum required Provenance-only lifecycle state. archived marks a git-backed List whose key was removed from the repo; it never blocks membership or mailability, and the List reactivates in place if the key returns.
One of: active, archived
created_at string<date-time> required updated_at string<date-time> required code is conflict.
application/problem+json code is internal_error. The
request_id field can be quoted to SendOps support to investigate.
application/problem+json