Custom Tracking Domains

Validate Custom Tracking Domain

Validate the given custom tracking domain.

post/v1/management/ctd/validate

Request

  • Base URL: https://api.leadboxer.com
  • URL: https://api.leadboxer.com/v1/management/ctd/validate
  • Auth: API key in header x-api-key

Request body

ctdstring required
datasetIdstring required
descriptionstring

Description for the given custom tracking domain

Example request

{
  "ctd": "track.companyname.com"
}

Response

OK

responseCodeinteger
responseMessagestring
messageTypestring

Indicates the result of custom tracking domain validation.

  • ERROR: Validation failed due to a client-side or server-side error.
  • WARNING: The domain is valid, but the DNS configuration is incomplete. Suggested CNAME records are returned.
  • SUCCESS: The domain is valid and correctly configured for tracking.

Example response

{
  "suggestions": [
    {
      "type": "CNAME",
      "host": "track",
      "value": "pixel.leadboxer.com"
    }
  ]
}

Changes

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