domain

Purchase domains and mailboxes as managed email-sending infrastructure

Place an order to purchase domains and mailboxes as managed email-sending infrastructure. Each domain gets one or more mailboxes provisioned by the chosen ESP.

<strong>Full purchase flow:</strong> <code>GET /v1/domain/search</code><code>GET /v1/domain/plans</code> → optional <code>POST /v1/domain/generate-mailbox-names</code><code>POST /v1/domain</code><code>GET /v1/domain</code>.

<strong>Payment:</strong> Paid orders return a <code>checkoutUrl</code> (Paddle/Stripe). <code>isFreeOrder: true</code> skips payment — only <code>orderId</code> returned.

<strong>Provisioning:</strong> Async — poll <code>GET /v1/domain</code> until <code>status</code> is no longer <code>inProgress</code>.

<code>redirectUrl</code> is a bare domain — <code>"acmecorp.com"</code> valid, <code>"https://acmecorp.com"</code> rejected. <code>phoneNumber</code> must be E.164 format. <code>country</code> must be ISO alpha-2.

post/v1/domain

Request body

domainOwnerFirstnamestring required

Registrant first name. 1–50 characters.

domainOwnerLastnamestring required

Registrant last name. 1–50 characters.

companyNamestring required

Registrant organisation name.

addressstring required

Registrant street address.

citystring

Registrant city.

statestring

Registrant state or province.

countrystring required

Registrant country. ISO alpha-2 code (e.g. "US", "IN").

zipcodestring required

Postal code. Must be valid for the given country.

phoneNumberstring required

Registrant phone in E.164 format — + + country code + number (e.g. "+14155551234").

emailServiceProvider'Google' | 'Microsoft' | 'Azure' required

The provider used to provision mailboxes. Determines pricing and infrastructure.

planType'quarterly' | 'annualFlexi' | 'annualFixed'

Billing cycle for mailbox subscriptions. "quarterly" (default), "annualFlexi", or "annualFixed". NOTE: Azure only supports "quarterly" — passing any other value returns a 400 error.

isReplacementboolean

Set true to fulfil this order using replacement-slot credits from a previously cancelled or expired order.

isFreeOrderboolean

Set true to use free-tier domain/mailbox credits on the account.

Example request

{
  "domainOwnerFirstname": "John",
  "domainOwnerLastname": "Smith",
  "companyName": "Acme Corp",
  "address": "123 Market Street",
  "city": "San Francisco",
  "state": "CA",
  "country": "US",
  "zipcode": "94105",
  "phoneNumber": "+14155551234",
  "emailServiceProvider": "Google",
  "planType": "quarterly",
  "domains": [
    {
      "name": "tryoutreachteam.com",
      "redirectUrl": "acmecorp.com",
      "mailboxes": [
        {
          "firstname": "John",
          "lastname": "Smith",
          "email": "john.smith@tryoutreachteam.com"
        }
      ]
    }
  ]
}

Response

Domain purchased successfully

Changes

No recorded changes to this endpoint across all 1 revision of this API.