Sign in
Domains

Set Up Domain

Provision the main sending identity (bare root domain) and notify.<rootDomain> (transactional) on a domain you own in one call. The main identity is used for campaigns and hand sends; notify.<rootDomain> is for receipts and password resets. If a legacy send.<rootDomain> marketing identity already exists, it is included in the response; new setups do not create marketing. Idempotent. Safe to call again if DNS records already exist. Returns DNS records for each provisioned identity. Requires API key with domains:write.

post/v1/domains/setup

Request body

rootDomainstring required

The apex domain you own, e.g. 'acme.com'

fromNamestring

Default From display name for provisioned identities.

vanityRootFromboolean

Show the apex domain in the From header when DMARC passes. Defaults to true.

Response

Domain setup complete

successboolean

Changes

Changed in 2 of the 6 revisions of this API.13

  • 6b3357db6cf63See the full diff
    • ○

      added the optional property data/marketing to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property data/main to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/transactional to the response with the 200 status

      response-required-property-added

  • 3f3dba69574b1See the full diff
    • ●

      removed the request property region

      request-property-removed