Sign in

v1

latestOpenAPI 3.1.02026-07-24700259.3 KB
SENDER DOMAINS

Add a sender domain

Add a sender domain to your account. Note that you must own any domains you wish to include in this list, as you will be required to verify and authenticate the emails sent via that domain. Find full details in the Sender Domains Guide.

post/domain/add

Request body

domainstring required

Domain to add as a sender domain

tracking_subdomainstring

An optional subdomain used for click or open tracking and unsubscribe links

returnpath_subdomainstring

An optional subdomain to use as a return-path subdomain

auto_verifyboolean

If true, verify the domain now removing the need to call the 'domain/verify' endpoint or wait for the periodic verification every 7 minutes.<br> <br> <strong>Note:</strong> In order to successfully complete the verification, the 'tracking_subdomain' and 'returnpath_subdomain' must be configured in the domain DNS and propagated.

requisition_sslboolean

If true, requisition an SSL certificate for the tracking domain once verification is complete

subaccount_idstring

If you wish to make this API call on behalf of a subaccount then include its unique ID here

Response

Domain added

request_idstring required

Example response

{
  "request_id": "e023461c-8c86-11e9-b984-408d5cce2644",
  "data": {
    "domains": [
      {
        "domain": {
          "dkim_value": "dkim.smtp2go.net",
          "domain": "example",
          "suffix": "com",
          "rpath_verified": true,
          "rpath_value": "return.smtp2go.net",
          "dkim_verified": true,
          "fulldomain": "example.com",
          "dkim_selector": "s123456"
        },
        "trackers": [
          {
            "domain": "example",
            "suffix": "com",
            "subdomain": "link",
            "fulldomain": "link.example.com"
          }
        ]
      }
    ]
  }
}