v49

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-02-185890337.1 KB

Tracking

Update track domain

Update track domain settings.

Use this to:

Enable/disable click tracking
Enable/disable open tracking
Enable/disable SSL
Set excluded click domains

patch/tenants/{tenantId}/tracking/{trackingId}

Request body

trackClicksboolean nullable

Enable or disable click tracking (accepts null)

trackOpensboolean nullable

Enable or disable open tracking (accepts null)

sslEnabledboolean nullable

Enable or disable SSL for tracking URLs (accepts null)

excludedClickDomainsstring nullable

Comma-separated list of domains to exclude from click tracking (accepts null)

Example request

{
  "excludedClickDomains": "example.com,mysite.org"
}

Response

Track domain updated

successtrue required

Example response

{
  "data": {
    "id": "1",
    "name": "track",
    "fullName": "track.example.com",
    "domainId": "123",
    "dnsOk": true,
    "dnsRecord": {
      "type": "CNAME",
      "name": "track.example.com",
      "value": "track.mail.arkhq.io"
    }
  },
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}