inboxes

Purge a temporary inbox now

DELETE /v1/inboxes/{id}

Auth required api.inboxes.manage

IRREVERSIBLE, and classified destructive — a sk_test_ credential is refused with test_environment_forbidden.

The purge happens before the response returns: the parsed messages leave Redis, the raw original and every staged attachment leave S3, and the row is marked deleted. There is no backup behind any of it, because the whole promise of a temporary inbox is that it leaves nothing. Mail already delivered here is gone.

You do not need to call this. An inbox deletes itself at expires_at; this is for finishing early.

A second call is 404. If you want "make sure it is gone", treat 204 and 404 as the same outcome.

Path parameters

id string<uuid> required

The inbox's UUID, exactly as returned by POST /v1/inboxes. A value that is not a UUID is a 404 rather than a 422 — it names nothing, and saying "that is not a valid UUID" would confirm the format of ids that do exist.

Responses

Errors follow the RFC 7807 problem format — see the error reference.

204 The inbox and everything it held are deleted

401 Missing, malformed, or unknown API key application/problem+json

403 Either the credential lacks the required scope (code: invalid_scope), or it is bound to the test environment and this operation is irreversible (code: test_environment_forbidden). Branch on code: the first is fixed by granting the scope, the second only by using a live credential. See the "Live and test credentials" section of the API description. application/problem+json

404 Resource not found application/problem+json

429 Per-org rate limit exceeded application/problem+json

500 Unexpected server-side failure. The code is internal_error. The request_id field can be quoted to SendOps support to investigate. application/problem+json