cherami.
API referenceInboxes and rules

Delete an inbox

DELETE /v1/inboxes/{inbox_id}

Read as Markdown ↗

DELETE /v1/inboxes/{inbox_id}

Requires an API key: Authorization: Bearer YOUR_CREDENTIAL.

Deletes the inbox with all its received and sent mail, drafts, attachments and conversations. Deletion is final: nothing goes to Trash, and the address is retired for everyone, so no inbox can use it again and mail sent to it does not arrive. Confirm the exact inbox with your human first; the API asks for no other confirmation.

The slot is freed at once. A repeated request returns 202 or 404.

Deletion guide

Parameters

ParameterLocationRequiredTypeMeaning
inbox_idpathYesstringCherami resource ID returned by the API.

curl example

Supply CHERAMI_API_KEY privately.

curl --silent --show-error --include --request DELETE \
  "https://cherami.to/v1/inboxes/INBOX_ID" \
  --header "Authorization: Bearer $CHERAMI_API_KEY"

Responses

HTTP 202

Accepted.

  • X-Request-ID: Identifies this request; include it when reporting a problem.

Content type: application/json.

Deleted

{
  "id": "11111111-1111-4111-8111-111111111111",
  "status": "deletion_pending",
  "message": "Example"
}

HTTP 401

unauthorized: Send a valid API key as Authorization: Bearer <key>. If the key stopped working, get a new one through recovery.

  • X-Request-ID: Identifies this request; include it when reporting a problem.
  • WWW-Authenticate: "Bearer"

Content type: application/json.

Error

HTTP 403

operation_not_allowed: Sending, or deletion and restore, is turned off for this account; the message says which. Contact hello@cherami.to.

  • X-Request-ID: Identifies this request; include it when reporting a problem.

Content type: application/json.

Error

HTTP 404

not_found: The resource does not exist or does not belong to this account. A reply or forward source must also be in the sending inbox.

  • X-Request-ID: Identifies this request; include it when reporting a problem.

Content type: application/json.

Error

HTTP 500

internal_error: The operation failed. Retry a read; after a write the change may have happened, so recover as retry by operation describes.

  • X-Request-ID: Identifies this request; include it when reporting a problem.

Content type: application/json.

Error

Schema: Deleted

FieldRequiredTypeMeaning and constraints
idYesstringCherami resource ID.
statusYes"deletion_pending"
messageYesstring

Schema: Error

FieldRequiredTypeMeaning and constraints
errorYesobject

error fields

FieldRequiredTypeMeaning and constraints
codeYesstringCode to handle. Handle a code you don't recognize by its HTTP status.
messageYesstringExplanation of this case; its wording can change.

Errors, limits and pagination · Download OpenAPI 3.1

On this page