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).
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. Accepted on every List route, read and write alike.
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.
status string enum required Lifecycle state. archived never blocks membership or mailability.
One of: active, archived
created_at string<date-time> required updated_at string<date-time> required code is conflict.
application/problem+json validation_failed Problem. When the refusal is about a
reference — a segment key, template slug, topic or attribute name the
organization does not have — it additionally carries validation_code,
field, line/column, missing, candidates and next_step, so a
client can correct the call without a second round of guessing. See
ValidationProblem.
application/problem+json code is internal_error. The
request_id field can be quoted to SendOps support to investigate.
application/problem+json