Skip to main content
POST
Node.js

Headers

X-Api-Key
string
required

Body

application/json
hostname
string
required

The hostname to register as a custom tracking domain (e.g., click.example.com). The hostname must have a CNAME record pointing to links.mailchannels.net.

name
string
required

A unique label used to select this domain at message send time

Maximum string length: 64
Pattern: ^[a-z0-9-]+$
scope
enum<string>
required

The event type this domain handles

Available options:
click,
open,
unsubscribe

Response

Domain verified and registered

created_at
string<date-time>
required

ISO 8601 timestamp when the domain was registered

hostname
string
required

The registered domain hostname

name
string
required

The label for this custom tracking domain

scope
enum<string>
required

The event type this domain handles

Available options:
click,
open,
unsubscribe
status
enum<string>
required

Current status of the custom tracking domain

Available options:
active,
disabled