Sign in

v49

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

Create track domain

Create a new track domain for open/click tracking for a tenant.

After creation, you must configure a CNAME record pointing to the provided DNS value before tracking will work.

post/tenants/{tenantId}/tracking

Path parameters

tenantIdstring required

The tenant ID

Request body

namestring required

Subdomain name (e.g., 'track' for track.yourdomain.com)

domainIdinteger required

ID of the sending domain to attach this track domain to

trackClicksboolean nullable

Enable click tracking (accepts null, defaults to true)

trackOpensboolean nullable

Enable open tracking (tracking pixel, accepts null, defaults to true)

sslEnabledboolean nullable

Enable SSL for tracking URLs (accepts null, defaults to true)

Example request

{
  "name": "track",
  "domainId": 123
}

Response

Track domain created

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"
  }
}