Add a tracking domain
Adds hostname as your organization’s tracking domain and answers it with its dnsTarget, pending_dns when it is new. Then add one CNAME record at your DNS provider: its name is the hostname and its value is dnsTarget. The domain is checked every 5 minutes for about a day, or at once with POST /v1/tracking-domains/{trackingDomainId}/verify; once the record is found, the hostname is set up and its certificate issued, and it becomes active, usually within half an hour. Follow its status with GET /v1/tracking-domains.
Once it is active, every campaign with click tracking on (clickTrackingEnabledAt) sends its tracked links through it: a link in its emails goes to your hostname, where a short redirect page sends the person on to the address you wrote. A campaign with click tracking off sends links as written. The open tracking image, the unsubscribe link, test emails and messages sent outside a campaign never use it.
The hostname must be a subdomain of at least three labels, such as go.fernway.co: fernway.co answers 422 invalid_tracking_hostname. An organization has one tracking domain at a time (409 tracking_domain_limit_reached): delete it to add another. A hostname another organization holds answers 409 tracking_hostname_already_claimed. Adding a hostname you deleted after it became active brings that same domain back, with the id it had, checked at once, so it can answer active straight away.
Tracking domain calls have a limit of their own, 30 a minute and 1,000 a day. Adding, checking and deleting one also share a tighter one, 10 a minute and 200 a day.
Free. Scope: campaigns, with a key that can write.
Authorizations
Body
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.
4 - 253"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.
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.
pending_dns, verifying, active, failed