Skip to main content
POST
/
tracking
Create track domain
curl --request POST \
  --url https://api.arkhq.io/v1/tracking \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "track",
  "domainId": 123,
  "trackClicks": true,
  "trackOpens": true,
  "sslEnabled": true
}
'
{
  "success": true,
  "data": {
    "id": "1",
    "name": "track",
    "fullName": "track.example.com",
    "domainId": "123",
    "trackClicks": true,
    "trackOpens": true,
    "sslEnabled": true,
    "dnsOk": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "excludedClickDomains": "<string>",
    "dnsStatus": "ok",
    "dnsError": "<string>",
    "dnsCheckedAt": "2023-11-07T05:31:56Z",
    "dnsRecord": {
      "type": "CNAME",
      "name": "track.example.com",
      "value": "track.mail.arkhq.io"
    },
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}

Authorizations

​
Authorization
string
header
required

Use your API key from arkhq.io/org/credentials

Authorization: Bearer YOUR_API_KEY

Body

application/json
​
name
string
required

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

Minimum string length: 1
Example:

"track"

​
domainId
integer
required

ID of the sending domain to attach this track domain to

Required range: x >= 1
Example:

123

​
trackClicks
boolean | null
default:true

Enable click tracking (accepts null, defaults to true)

​
trackOpens
boolean | null
default:true

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

​
sslEnabled
boolean | null
default:true

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

Response

Track domain created

​
success
boolean
required
​
data
object
required
​
meta
object
required