Create a list

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

Path parameters

id

required

string

Inbox UUID

Request body

Content-Type: application/json

`name` required string
`description` string

Responses

201application/jsonCreated

`id` string	format: uuid
`name` string
`description` string
`entryCount` integer
`entries` object[]
`id` string	format: uuid
`email` string	format: email
`displayName` string
`metadata` object
`createdAt` string	format: date-time
`createdAt` string	format: date-time

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

Example response · 201

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "description": "string",
  "entryCount": 0,
  "entries": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "email": "[email protected]",
      "displayName": "string",
      "metadata": {},
      "createdAt": "2026-05-01T08:11:44.802Z"
    }
  ],
  "createdAt": "2026-05-01T08:11:44.802Z"
}