Skip to main content
DELETE
Remove Recipients
Removal is a soft state. A removed recipient stops getting release emails but keeps their row, so a later upsert or add puts them back, and a contact who unsubscribed themselves can never be removed-then-re-added as a way around their opt-out. Two forms:
  • Single — DELETE /email/lists/{list_id}/recipients/{identifier}, where identifier is matched as an email address first (case-insensitive), then as an external_id.
  • Batch — POST /email/lists/{list_id}/recipients/remove with emails and/or external_ids, up to 1000 identifiers.
Both are idempotent.

Authentication

This endpoint requires an API token passed as a Bearer token in the Authorization header.

Single removal

Path Parameters

string
required
The mailing list’s unique identifier (UUID).
string
required
An email address or an external_id. URL-encode it (@ is fine as is in most clients).

Request

cURL

Response

string
required
removed (was active), already_removed, or unsubscribed (left untouched).
200

Batch removal

POST /email/lists/{list_id}/recipients/remove

Body

string[]
Email addresses to remove
string[]
External ids to remove
At least one of the two, at most 1000 identifiers in total.

Request

cURL

Response

integer
required
Active recipients now removed
integer
required
Identifiers that were already removed
integer
required
Identifiers matching unsubscribed recipients (untouched)
string[]
required
Identifiers that matched nothing on this list
200

Errors

Rate Limits

Both forms are limited to 30 requests per minute per IP.