Delete a static List

Search Documentation

Search across all developer documentation

lists

Delete a static List

DELETE /v1/lists/{id}
Auth required api.lists.manage

Deletes a managed List definition. On writes, {id} resolves as a UUID or, failing that, as the List's org-unique key. Git-backed Lists are read-only here (409 conflict) — the sync owns them, and removing the key from the repo archives (never deletes) the List. The ClickHouse membership log is left in place (harmless once the definition is gone).

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.

Responses

Errors follow the RFC 7807 problem format — see the error reference.

204 List deleted (no content)
401 Missing, malformed, or unknown API key application/problem+json
403 Either the credential lacks the required scope (code: invalid_scope), or it is bound to the test environment and this operation is irreversible (code: test_environment_forbidden). Branch on code: the first is fixed by granting the scope, the second only by using a live credential. See the "Live and test credentials" section of the API description. 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
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