Update inbox display name or metadata

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

Username, domain, and canonical identity are immutable. Use POST /v1/inboxes/{id}/addresses to change the outbound From.

Path parameters

id

required

string

Inbox UUID

Request body

Content-Type: application/json

`displayName` string
`metadata` object

Responses

200application/jsonUpdated

`updated` 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! });

// PATCH /v1/inboxes/{id}
const result = await client.request("patch", "/v1/inboxes/{id}", { params: { id: "00000000-0000-0000-0000-000000000000" } }, { body: {
  "displayName": "string",
  "metadata": {}
} });

Example response · 200

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