cherami.
API referenceSending and allowance

Delete a sent copy

DELETE /v1/sent/{message_id}

Read as Markdown ↗

DELETE /v1/sent/{message_id}

Requires a Claim-issued API key: Authorization: Bearer YOUR_CREDENTIAL.

DELETE /v1/sent/{message_id} returns 202 with id and status: "deletion_pending". Permanently deletes the sent copy and its attachments with no trash or undo. Deletion does not refund sending quota. Repeating DELETE is safe and can return 202 or 404.

Parameters

ParameterLocationRequiredTypeMeaning
message_idpathYesstringOwned Cherami resource ID returned by the API.

curl example

Replace resource-ID placeholders with returned IDs. Supply CHERAMI_API_KEY through your private shell environment.

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

Responses

HTTP 202

Request accepted; inspect the response for its meaning.

  • X-Request-ID: Support correlation ID, not an idempotency key.

Content type: application/json.

Deleted

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

HTTP 401

unauthorized: Provide a valid bearer credential. Use human-approved recovery if access is lost.

  • X-Request-ID: Support correlation ID, not an idempotency key.
  • WWW-Authenticate: "Bearer"

Content type: application/json.

Error

HTTP 403

operation_not_allowed: This account cannot send mail, delete mail, or delete inboxes. Contact support if unexpected.

  • X-Request-ID: Support correlation ID, not an idempotency key.

Content type: application/json.

Error

HTTP 404

not_found: Resource is absent or inaccessible to this account. Reply targets must be in the sending inbox.

  • X-Request-ID: Support correlation ID, not an idempotency key.

Content type: application/json.

Error

HTTP 500

internal_error: Operation failed; a write may already have happened. Follow the operation-specific recovery below.

  • X-Request-ID: Support correlation ID, not an idempotency key.

Content type: application/json.

Error

Schema: Deleted

FieldRequiredTypeMeaning and constraints
idYesstringCherami resource ID, distinct from the RFC Message-ID. Use the returned value.
statusYes"deletion_pending"
messageYesstring

Schema: Error

FieldRequiredTypeMeaning and constraints
errorYesobject

error fields

FieldRequiredTypeMeaning and constraints
codeYesstringProgrammatic error code. Handle unrecognized codes by status and operation-specific recovery.
messageYesstringHuman-readable context, not a stable string to match.

HTTP conventions, errors and pagination · Download OpenAPI 3.1

On this page