Create a static List

Search Documentation

Search across all developer documentation

lists

Create a static List

POST /v1/lists
Auth required api.lists.manage

Creates a new managed static List definition. key is optional and defaults to a slug derived from the name (matching the dashboard create); it is the stable org-unique handle other calls reference the List by, and is immutable afterwards. A key already in use returns 409 conflict. Definition-only: add members via the contacts surface.

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.

201 The created List application/json
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
401 Missing, malformed, or unknown API key application/problem+json
403 Key lacks the required scope or plan limit violated application/problem+json
409 The mutation is rejected by a state rule rather than a bad request. The code is conflict. application/problem+json
422 A query parameter, path value or body field failed validation. The body is a 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
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