Enable a custom tracking domain

Provisions a custom tracking domain (default label `track`) for a verified sending domain so open/click links redirect through the customer's own subdomain.

POST
/v1/email/domains/{id}/custom-tracking

Provisions a custom tracking domain (default label track) for a verified sending domain so open/click links redirect through the customer's own subdomain. Requires the custom_tracking_domain entitlement. Returns the resulting state including the two DNS records the customer must create.

x-api-key<token>

In: header

Path Parameters

id*string
Match^dom_[0-9a-hjkmnp-tv-z]{16,24}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

label?string|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/email/domains/string/custom-tracking" \  -H "Content-Type: application/json" \  -d '{}'
{  "enabled": true,  "customTracking": {    "status": "pending",    "label": "string",    "hostname": "string",    "region": "string",    "sslStatus": "string",    "dnsRecords": {      "tracking": {        "name": "string",        "type": "string",        "value": "string"      },      "dcvDelegation": {        "name": "string",        "type": "string",        "value": "string"      }    },    "caaBlocked": true,    "verificationErrors": [      "string"    ],    "teardownScheduledAt": "string"  }}