Skip to main content
POST
Add a tracking domain

Authorizations

Authorization
string
header
required

An API key from the console, starting ob_live_, sent as Authorization: Bearer <key>.

Body

application/json
hostname
string
required

A subdomain of a domain you own, such as go.fernway.co, without https:// or a path: the hostname the tracked links of your campaign emails will go through. It needs at least three labels, so fernway.co is refused. It is lower-cased.

Required string length: 4 - 253
Example:

"go.fernway.co"

Response

The tracking domain: pending_dns when it is new. A hostname you deleted and add again comes back with the id it had, in the state its check finds it in.

id
string
required
hostname
string
required

The hostname the tracked links go through, such as go.fernway.co.

status
enum<string>
required

pending_dns while it waits for its CNAME record or its certificate, verifying while the hostname is set up: it can pass through both more than once. Then active, the only state campaigns use it in. failed when it has not become active after about a day of checks, or when its setup was lost.

Available options:
pending_dns,
verifying,
active,
failed
dnsTarget
string
required

The value of the one CNAME record to add, the record whose name is hostname.

verifiedAt
string<date-time>

When it last became active. Absent until it first does.

lastCheckedAt
string<date-time>

When it was last checked. Absent before the first check.

createdAt
string<date-time>