Register a custom domain

POSThttps://myagentmail.com/v1/domains

Returns the DNS records you need to set at your registrar. Domain starts in pending status until you call the verify endpoint.

Request body

Content-Type: application/json

domain

required

string

workspaceId

string

(Tenant master only) target workspace.

format: uuid

Responses

201application/jsonCreated

`id` string	format: uuid
`domain` string
`status` "pending" \| "verified" \| "failed"	enum: "pending" \| "verified" \| "failed"
`workspaceId` string	format: uuid
`dnsRecords` object[]
`type` "TXT" \| "CNAME" \| "MX" \| "A"	enum: "TXT" \| "CNAME" \| "MX" \| "A"
`name` string
`value` string
`priority` integer
`status` "pending" \| "verified"	enum: "pending" \| "verified"
`createdAt` string	format: date-time
`updatedAt` 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/domains
const result = await client.request("post", "/v1/domains", { body: {
  "domain": "mail.example.com",
  "workspaceId": "00000000-0000-0000-0000-000000000000"
} });

Example response · 201

{
  "id": "00000000-0000-0000-0000-000000000000",
  "domain": "string",
  "status": "pending",
  "workspaceId": "00000000-0000-0000-0000-000000000000",
  "dnsRecords": [
    {
      "type": "TXT",
      "name": "string",
      "value": "string",
      "priority": 0,
      "status": "pending"
    }
  ],
  "createdAt": "2026-05-01T08:11:44.887Z",
  "updatedAt": "2026-05-01T08:11:44.887Z"
}