Add an alias address

POSThttps://myagentmail.com/v1/inboxes/{id}/addresses

Attach another accepted address to this inbox. If primary: true (the default), it also becomes the outbound From. The domain must be either the default domain or a custom domain registered + verified to the same workspace.

Path parameters

id

required

string

Inbox UUID

Request body

Content-Type: application/json

`email` required string	format: email
`primary` boolean	default: true

Responses

201application/jsonCreated

`ok` boolean
`address` string
`isPrimary` boolean

409application/jsonResource already exists

`error` required string
`code` 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! });

// POST /v1/inboxes/{id}/addresses
const result = await client.request("post", "/v1/inboxes/{id}/addresses", { params: { id: "00000000-0000-0000-0000-000000000000" } }, { body: {
  "email": "[email protected]",
  "primary": true
} });

Example response · 201

{
  "ok": false,
  "address": "string",
  "isPrimary": false
}