Receiving Domains

Add receiving domain

Changed on

Adds your workspace's receiving domain, a domain or subdomain whose mail should reach your Inbox, and returns the DNS records to publish. A workspace has one receiving domain. Once it is verified, replies to emails from all your sending domains come back to reply addresses on it, and its first verification turns Inbox on; until then replies use inbound.sequenzy.com. Mail for a domain goes wherever its MX records point, so a domain whose MX records already point at another mail service (Google Workspace, Microsoft 365, Cloudflare Email Routing) is refused: use a subdomain such as support.acme.com instead. When the workspace already has a receiving domain, a different name is refused with limit_reached before any DNS lookup. Adding a name this workspace already has returns it unchanged with created false, without checking its MX records again, so retries are safe. Adding the first receiving domain also sets the company's reply domain mode to custom. Requires the websites:write scope and owner or admin access.

post/receiving-domains

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/receiving-domains
  • Auth
    HTTP bearer

Request body

domainstring required

Domain or subdomain you own, such as acme.com or support.acme.com. Case and a trailing dot are ignored.

Example request

{
  "domain": "support.acme.com"
}

Response

This workspace already has the domain; returned unchanged

successboolean required
createdboolean required

True when the domain was added; false when this workspace already had it.

Example response

{
  "success": true,
  "receivingDomain": {
    "id": "rd_abc123",
    "domain": "support.acme.com",
    "records": [
      {
        "name": "support.acme.com",
        "value": "inbound-smtp.us-east-1.amazonaws.com",
        "priority": 10
      }
    ],
    "error": "Add the TXT record so Amazon SES can confirm you own support.acme.com."
  }
}

Changes