Archive an email list
Archives an email list by setting its status to archived; the list and its members are retained but the list no longer appears in GET /v1/audiences and can no longer be fetched or broadcast to.
Archives an email list by setting its status to archived; the list and its members are retained but the list no longer appears in GET /v1/audiences and can no longer be fetched or broadcast to. Returns 204 with an empty body. Archiving an already-archived, unknown, or cross-project audienceId returns 404 rather than silently succeeding. Requires the audiences:write scope.
Scope: audiences:write. Send the API key as a bearer token; Scopes lists what each one reaches.
Request
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
audienceId | string (uuid) | yes | The audience's ID. |
Response
200 Success. Body: application/json, AudienceDeleteResponse.
| Field | Type | Required | Description |
|---|---|---|---|
deleted | boolean | yes | |
id | string (uuid) | yes |
Errors
Every error has the same body, {"error": {"type", "code", "message", "param"}}; branch on code. Errors lists every code.
| Status | Meaning |
|---|---|
400 | The request is malformed or a value is invalid (invalid_request, invalid_domain, idempotency_key_mismatch). |
401 | The API key is missing or invalid. |
403 | The key lacks the scope this endpoint needs (scope_missing) or may not do this (not_permitted). |
404 | No such resource in this account (resource_not_found). |
422 | The request is well-formed but a field failed validation (validation_failed). |
429 | Rate limit, plan limit, budget or spend cap reached (rate_limited, plan_limit_reached, budget_exceeded, spend_cap_reached). |
500 | An unexpected error; retry with backoff, then contact support (internal_error). |
Get an email list and its members
Returns one active email list as an audience object with its members inlined as a members array of audience_member objects, each carrying the recipient handle, optional contactId, name, metadata, source, and status.
Add or update email-list members
Adds or updates members on a list in one batch and returns { "audienceId", "imported" }, where imported is the number of members submitted.