Delete an inbox

DELETEhttps://myagentmail.com/v1/inboxes/{id}

Soft-deletes the inbox, hard-deletes its alias rows, and removes the Stalwart principal. Prior threads and messages are preserved but hidden from listings.

Path parameters

id

required

string

Inbox UUID

Responses

200application/jsonDeleted

`deleted` boolean
`id` string	format: uuid

Authentication

Send your API key in the X-API-Key header (or Authorization: Bearer <key>). Any prefix accepted by this endpoint — tk_, wk_, ak_, or sa_ — is documented in the key prefix table.

Request

import { MyAgentMail } from "myagentmail";

const client = new MyAgentMail({ apiKey: process.env.MYAGENTMAIL_API_KEY! });

// DELETE /v1/inboxes/{id}
const result = await client.request("delete", "/v1/inboxes/{id}", { params: { id: "00000000-0000-0000-0000-000000000000" } });

Example response · 200

{
  "deleted": false,
  "id": "00000000-0000-0000-0000-000000000000"
}