Remove an alias address

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

Cannot remove the canonical (initial) address. If the removed alias was primary, the canonical address becomes primary again.

Path parameters

`id` required string	Inbox UUID
`address` required string	URL-encoded alias email

Responses

200application/jsonRemoved

`deleted` boolean
`address` string

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}/addresses/{address}
const result = await client.request("delete", "/v1/inboxes/{id}/addresses/{address}", { params: { id: "00000000-0000-0000-0000-000000000000", address: "string" } });

Example response · 200

{
  "deleted": false,
  "address": "string"
}