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 — including a key owned by a git-backed List (the repo owns that key). Definition-only: add members via the contacts surface.

Request body

Content type: application/json

{
  "name": "string",
  "key": "string",
  "description": "string"
}

Responses

201 The created 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
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