Domains

Domains must be verified with SPF, DKIM, and DMARC before you can send. Guide: Domain verification.

Create domain

POST /v1/domains

Field	Type	Required	Description
name	string	Required	Apex or subdomain, e.g. `mail.example.com`.
productType	string	Optional	`api` (default), `mailbox`, or `both`.
region	string	Optional	Sending region, e.g. `sg` (default).

{
  "id": "dom_01",
  "name": "yourdomain.com",
  "status": "pending",
  "productType": "api",
  "region": "sg",
  "records": [
    { "type": "TXT", "name": "yourdomain.com", "value": "v=spf1 include:spf.xurel.co ~all", "status": "pending" },
    { "type": "CNAME", "name": "xrl1._domainkey.yourdomain.com", "value": "xrl1.dkim.xurel.co", "status": "pending" },
    { "type": "TXT", "name": "_dmarc.yourdomain.com", "value": "v=DMARC1; p=none;", "status": "pending" }
  ]
}

List domains

GET /v1/domains

Cursor pagination. See Pagination.

Retrieve domain

GET /v1/domains/{id}

Verify domain

POST /v1/domains/{id}/verify

Triggers a DNS re-check. Returns updated record statuses.

Update domain

PATCH /v1/domains/{id}

Field	Type	Required	Description
trackingSubdomain	string	Optional	Custom tracking host, e.g. `click.example.com`.
openTracking	boolean	Optional	Enable open tracking.
clickTracking	boolean	Optional	Enable click tracking.
productType	string	Optional	`api`, `mailbox`, or `both`.
region	string	Optional	Sending region.

Delete domain

DELETE /v1/domains/{id}

Returns 204 No Content. You cannot delete a domain with active scheduled sends.