Delete a draft
DELETE /v1/drafts/{draft_id}
Read as Markdown ↗DELETE /v1/drafts/{draft_id}
Requires an API key: Authorization: Bearer YOUR_CREDENTIAL.
Deletes the draft and its attachments. This is final: drafts don't go to Trash. A submitted draft's sent message is separate, and deleting one doesn't delete the other. A repeated request returns 202 or 404.
Parameters
| Parameter | Location | Required | Type | Meaning |
|---|---|---|---|---|
draft_id | path | Yes | string | Cherami resource ID returned by the API. |
curl example
Supply CHERAMI_API_KEY privately.
curl --silent --show-error --include --request DELETE \
"https://cherami.to/v1/drafts/DRAFT_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.
{
"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.
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.
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.
HTTP 503
draft_unavailable: The draft request failed. Repeat a draft send with the same draft ID: it never sends twice. Repeat a creation with its original idempotency key and payload; without a key, list drafts first. Read the draft before repeating an edit. Retry a read or a deletion.
X-Request-ID: Identifies this request; include it when reporting a problem.
Content type: application/json.
Schema: DeletedDraft
| Field | Required | Type | Meaning and constraints |
|---|---|---|---|
id | Yes | string | Cherami resource ID. |
status | Yes | "deletion_pending" | |
message | Yes | string |
Schema: Error
| Field | Required | Type | Meaning and constraints |
|---|---|---|---|
error | Yes | object |
error fields
| Field | Required | Type | Meaning and constraints |
|---|---|---|---|
code | Yes | string | Code to handle. Handle a code you don't recognize by its HTTP status. |
message | Yes | string | Explanation of this case; its wording can change. |