Websites

Configure domain tracking (deprecated)

Changed on

Deprecated: tracking is company-wide; use PUT /tracking-domain. Sets <trackingPrefix>.<domain> as the company tracking domain when the company has none. Publish the returned tracking.cnameRecord; sending never waits for it, and links use the shared Sequenzy tracking domain until it verifies. Repeating the company's current tracking hostname is a no-op. A different value is accepted but changes nothing, and the response message says so; it never replaces the company setting.

patch/websites/{domain}

Request

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

Path parameters

domainstring required

Configured sending domain

Request body

trackingPrefixstring required

Tracking subdomain label, for example links. One DNS label of 1 to 63 letters, numbers or hyphens; inbound is reserved.

Response

Tracking subdomain saved

successboolean
messagestring

Present when nothing changed because the company already uses another tracking domain.

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