Websites

Add sending domain

Changed on

Adds a sending domain to the authenticated company and returns the SPF, DKIM, MAIL FROM, DMARC, and tracking DNS records required for setup. Tracked links use the company tracking domain, shared by every sending domain: the first domain creates it on its root (links.<root>) and returns its CNAME as dnsRecords.trackingRecord. It is optional and never gates verification or sending. A domain belongs to exactly one company, so confirm the target company before adding it.

post/websites

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/websites
  • Auth
    HTTP bearer

Request body

domainstring required

Domain to add.

mailFromPrefixstring

Return-path (MAIL FROM) subdomain label. Defaults to rp. New domains also get a second return path, usually <label>2 (rp2 by default); publish the returned names. One DNS label of 1 to 63 letters, numbers or hyphens; inbound is reserved. Applies only when the domain is created; re-adding an existing domain returns its stored records.

trackingPrefixstring

Label of the company tracking domain created on the domain's root (<label>.<root>) when the company has none yet; ignored otherwise. Defaults to links. When the hostname is taken, the label followed by 2 to 5 is tried (for example links2); when none is free, the domain is added without a tracking domain. A label that would land on the bounce hostname returns 400. Change the tracking domain later with PUT /tracking-domain.

Example request

{
  "mailFromPrefix": "bounce",
  "trackingPrefix": "links"
}

Response

Website added

successboolean

Example response

{
  "success": true,
  "website": {
    "domain": "mail.example.com",
    "status": "pending",
    "dnsRecords": {
      "platformDnsRecords": [
        {
          "name": "sq1._domainkey.mail.example.com",
          "value": "sq1.k7f3q2ab.d.sequenzydns.com"
        }
      ],
      "returnPathCnameRecord": {
        "name": "send.mail.example.com",
        "value": "send.sequenzydns.com"
      },
      "inboundVerificationRecord": {
        "name": "_amazonses.inbound.example.com"
      },
      "trackingRecord": {
        "name": "links.example.com",
        "value": "links1.sequenzydns.com"
      }
    },
    "tracking": {
      "hostname": "links.example.com",
      "cnameRecord": {
        "name": "links.example.com",
        "value": "links1.sequenzydns.com"
      }
    },
    "bounceRecords": {
      "cnameRecord": {
        "name": "send.mail.example.com",
        "value": "send.sequenzydns.com"
      }
    },
    "dnsUpgrade": {
      "records": [
        {
          "name": "sq1._domainkey.mail.example.com",
          "value": "sq1.k7f3q2ab.d.sequenzydns.com"
        }
      ],
      "replacedRecords": [
        {
          "name": "sequenzy._domainkey.mail.example.com"
        }
      ],
      "oldRecords": [
        {
          "name": "sequenzy._domainkey.mail.example.com"
        }
      ]
    }
  }
}

Changes

  • 42ac3429b60eRevision changes
    • info

      added the optional property / to the response with the status

  • db3873ca3d4dRevision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added to the response body anyOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      response property website/dnsRecords/inboundRoutingError deprecated

    • info

      response property website/dnsRecords/inboundRoutingStatus deprecated

    • info

      response property website/dnsRecords/inboundVerificationRecord deprecated

    • info

      response property website/dnsRecords/inboundVerificationStatus deprecated