Skip to main content
POST
Erase Recipients
Use this when a person asks you to erase their data (GDPR Article 17). Unlike a removal, which keeps the row so the contact can be restored, an erase deletes the recipient outright — email, name, external_id and attributes — in any status. One thing survives on purpose: if the person had unsubscribed, Shipstar keeps a one-way SHA-256 hash of their address on that list. A later upsert or add of the same address is then still skipped as unsubscribed, so erasing someone can never quietly re-subscribe them. The hash can’t be turned back into the address. Up to 1000 identifiers per call; emails match case-insensitively. A repeated call reports everything as not_found.

Authentication

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

Path Parameters

string
required
The mailing list’s unique identifier (UUID).

Body

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

Request

cURL

Response

integer
required
Recipients permanently deleted
integer
required
Of those, recipients who had unsubscribed — kept only as a hash so their opt-out holds
string[]
required
Identifiers that matched nothing on this list
200

Errors