Request
curl -X POST https://api.beaconbox.eu/api/v1/recipients/buyer@example.com/whatsapp/erase \
-H "Authorization: Bearer $BEACONBOX_API_KEY"
-H "Idempotency-Key: 8f2b1c04-3d6a-4e55-9a12-77c0b4e9d100"client.recipients.erase_whatsapp(email)$client->recipients->eraseWhatsApp($email)Path parameters
| Name | Type | Description |
|---|---|---|
email | email |
Response
Returns 200.
| Field | Type | Description |
|---|---|---|
replies_deleted | integer | Stored replies from this recipient that we deleted, bodies and metadata alike. |
webhook_payloads_scrubbed | integer | Copies of those replies removed from whatsapp.inbound_message webhook deliveries of ours. A delivery still queued for your endpoint now carries a null body; it will still tell you that a reply arrived and when. |
auto_reply_windows_dropped | integer | Rows holding this person's number so our automatic acknowledgement would not repeat itself. Dropping them can cost them one extra automatic reply if they write in again today, which is the right side of the trade for a number we were asked to erase. |
consent_withdrawn | boolean | True when this erasure moved them to stopped. Erasing the conversation while leaving the channel open to message them again is not a state we keep, so an erasure withdraws WhatsApp consent, permanently for your business. It cannot be restored through this API; you would have to collect consent again. False only when they had already stopped. |
replies_a_forward_email_may_have_carried | integer | Copies only you can delete: this number is your remaining work. Erased replies whose reply-forward notification had already run. Where your *Forward replies to email* setting was full at the time, the customer's words went to your admin users' mailboxes, and an inbox, an archive, a backup and a helpdesk's search index are all outside anything we can reach. We do not record what the setting was on the day, so this is an upper bound: search your own mail for this recipient, and your own store for anything you kept from a whatsapp.inbound_message delivery. Until you do, the erasure is ours only. |
forward_setting | "full" | "link_only" | "off" | Your forwarding setting now, so you know which mailboxes to search from here on: full sends the words, link_only sends a link to them, off sends nothing. It says nothing about what the setting was when the erased replies arrived. |
first_erased_at | date-time | When this recipient was first erased for your business. On a first erasure this is now; on a repeat it is the earlier date and the counts above are zero because there was nothing left, not because there never was anything. Retrying with the same Idempotency-Key replays the original counts instead. |
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.