Workspace

Declare the tracking domain

{ "hostname": "click.your-domain.com" }, or {} for the name suggested from a verified sending domain. Then add the CNAME to clients.clickmailcheer.com (DNS only): the domain becomes active as soon as a real HTTPS request comes back through it. Requires emails:send.

post/api/v1/tracking-domain

Request

  • Base URL: https://mailcheer.com
  • URL: https://mailcheer.com/api/v1/tracking-domain
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Request body

hostnamestring

Response

Declared.

object'tracking_domain'
hostnamestring nullable
statusstring nullable

pending_dns, verifying, issuing_certificate, active or failed.

activeboolean
reasonstring nullable
detailstring nullable
links_originstring nullable

The address that links and the pixel of new emails carry today.

created_atstring date-time nullable
activated_atstring date-time nullable
last_checked_atstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.