Delete an inbox
Hard-delete an inbox and its stored mail; the address is quarantined for a cooling-off period before it can be reused. An unknown, already-deleted, or cross-tenant id returns not-found — a delete is never silently successful on a missing inbox.
Hard-delete an inbox and its stored mail; the address is quarantined for a cooling-off period before it can be reused. An unknown, already-deleted, or cross-tenant id returns not-found — a delete is never silently successful on a missing inbox.
The per-tenant API key. Sent as the x-api-key request header. The key
is tenant-scoped.
In: header
Path Parameters
The inbox's opaque id (e.g. inb_…).
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/inboxes/string"{ "inbox_id": "string", "deleted": true}{ "name": "string", "message": "string"}{ "name": "string", "message": "string"}{ "name": "string", "message": "string"}{ "name": "string", "message": "string"}Create an inbox POST
Create an inbox and get back a live, addressable email identity. Every field is optional: omit `username` and a readable random address is generated on the shared domain. Supply a `client_id` for idempotency — repeating a create with the same `client_id` returns the existing inbox (`200`) instead of creating a duplicate.
Get an inbox GET
Fetch a single inbox by id. An unknown id and an id belonging to another tenant both return the same not-found error — existence is never leaked.