Add a tracking domain

POST

/mail/domains/{id}/tracking

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

idstringrequired

Id of the sending domain.

Body

application/json

hostnamestringrequired

Subdomain of the sending domain to track opens and clicks on, like track.example.com: up to 253 characters, lowercased.

Response

application/json

Success

idstringrequired

namestringrequired

The domain name, like example.com.

stateenum<string>required

provisioning while Bavimail sets the domain up, awaiting_dns until every check passes, ready once inboxes on it can send, or failed (see problem).

Available options: provisioning, awaiting_dns, ready, failed

recordsobject[]required

DNS records to publish at the domain's DNS host.

checksobject[]required

State of each DNS check Bavimail runs on the domain.

problemstring | nullrequired

What went wrong in the domain's setup, from Bavimail; null when nothing did.

automatic_setup_urlstring | nullrequired

Link that publishes the records at the domain's DNS host in one step; null when the DNS host does not support it.

trackingobject | nullrequired

The tracking domain used for open and click tracking; null when none is added.

created_atstringrequired

When the domain was added, as an ISO 8601 timestamp.

Add a tracking domain

curl --request POST \
  --url https://api.bavlio.com/mail/domains/{id}/tracking \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "hostname": "<string>"
}
'

curl --request POST \  --url https://api.bavlio.com/mail/domains/{id}/tracking \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{  "hostname": "<string>"}'

{
  "id": "<string>",
  "name": "<string>",
  "state": "provisioning",
  "records": [
    {
      "type": "TXT",
      "name": "<string>",
      "value": "<string>",
      "priority": 123,
      "ttl": 123
    }
  ],
  "checks": [
    {
      "check": "ownership",
      "state": "pending",
      "detail": "<string>"
    }
  ],
  "problem": "<string>",
  "automatic_setup_url": "<string>",
  "tracking": {
    "id": "<string>",
    "hostname": "<string>",
    "state": "awaiting_dns",
    "records": [
      {
        "type": "TXT",
        "name": "<string>",
        "value": "<string>",
        "priority": 123,
        "ttl": 123
      }
    ],
    "problem": "<string>"
  },
  "created_at": "<string>"
}

{  "id": "<string>",  "name": "<string>",  "state": "provisioning",  "records": [    {      "type": "TXT",      "name": "<string>",      "value": "<string>",      "priority": 123,      "ttl": 123    }  ],  "checks": [    {      "check": "ownership",      "state": "pending",      "detail": "<string>"    }  ],  "problem": "<string>",  "automatic_setup_url": "<string>",  "tracking": {    "id": "<string>",    "hostname": "<string>",    "state": "awaiting_dns",    "records": [      {        "type": "TXT",        "name": "<string>",        "value": "<string>",        "priority": 123,        "ttl": 123      }    ],    "problem": "<string>"  },  "created_at": "<string>"}