Add a list entry

POSThttps://myagentmail.com/v1/inboxes/{id}/lists/{lid}/entries

Path parameters

`id` required string	Inbox UUID
`lid` required string	List UUID

Request body

Content-Type: application/json

`email` required string	format: email
`displayName` string
`metadata` object

Responses

201application/jsonCreated

`id` string	format: uuid
`email` string	format: email
`displayName` string
`metadata` object
`createdAt` string	format: date-time

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}/lists/{lid}/entries
const result = await client.request("post", "/v1/inboxes/{id}/lists/{lid}/entries", { params: { id: "00000000-0000-0000-0000-000000000000", lid: "00000000-0000-0000-0000-000000000000" } }, { body: {
  "email": "[email protected]",
  "displayName": "string",
  "metadata": {}
} });

Example response · 201

{
  "id": "00000000-0000-0000-0000-000000000000",
  "email": "[email protected]",
  "displayName": "string",
  "metadata": {},
  "createdAt": "2026-05-01T08:11:44.888Z"
}