Request
curl -X POST https://api.beaconbox.eu/api/v1/recipients/buyer@example.com/erase \
-H "Authorization: Bearer $BEACONBOX_API_KEY"
-H "Idempotency-Key: 8f2b1c04-3d6a-4e55-9a12-77c0b4e9d100"client.recipients.erase(email)$client->recipients->erase($email)Path parameters
| Name | Type | Description |
|---|---|---|
email | email |
Response
Returns 200.
| Field | Type | Description |
|---|---|---|
messages_deleted | integer | Messages you sent them, subjects and bodies included. |
message_events_deleted | integer | Delivery, open and not-sent events about those messages. |
channel_sends_deleted | integer | SMS and WhatsApp send records, with the number they went to. Your credit ledger keeps its entries; they no longer point at a send. |
message_links_deleted | integer | Links that opened one of those messages. |
whatsapp_replies_deleted | integer | WhatsApp replies they sent you, bodies included. |
webhook_payloads_scrubbed | integer | Webhook deliveries of ours about this person whose address, subject, number or reply text we replaced with null. A delivery still queued for your endpoint will arrive with those fields empty. Copies your endpoint already received are yours to delete. |
queued_jobs_cancelled | integer | Nudges, texts and escalations still waiting to go out for those messages, now cancelled. |
idempotency_records_deleted | integer | Stored API responses that named this recipient. Retrying one of those requests with its original Idempotency-Key will run it again rather than replay it. |
audit_entries_pseudonymised | integer | |
subscription_deleted | boolean | Whether their recipient record (phone number, SMS and WhatsApp consent, unsubscribe state) was deleted. False when there was none, for example on a repeat erasure. An unsubscribe it held is kept first, as a suppression (suppressions_kept). |
stops_kept | integer | SMS or WhatsApp opt-outs for their number that we keep, so that nobody can text them again by pushing to this address later. Kept on purpose: an opt-out that is erased on request stops being one. |
suppressions_kept | integer | Email suppressions for this address that we keep, for the same reason: a hard bounce, a complaint, or their unsubscribe from your business, which would otherwise have gone with their recipient record. At most one, with one reason. |
auto_reply_windows_dropped | integer | Rows holding their number so our automatic WhatsApp acknowledgement would not repeat. |
replies_a_forward_email_may_have_carried | integer | An upper bound on erased WhatsApp replies that your reply-forward email had already sent to your admin users' mailboxes. Those copies are outside anything we can reach: search your own mail for this recipient. |
Errors
Failures are { "error_code": "..." } with a stable dotted code. See Errors for the codes worth branching on and the three outcomes that look like failures and are not.
This is a write, so it requires an Idempotency-Key header. A request without one is refused with 422. See Idempotency.