CustomTrackingDomainValidationResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/leadboxer-com/json-schema/leadboxer-com-custom-tracking-domain-validation-response-schema.json",
  "title": "CustomTrackingDomainValidationResponse",
  "description": "Represents the response returned after validating a custom tracking domain. The response indicates whether validation failed, succeeded, or requires additional DNS configuration, and may include suggested CNAME records to complete setup.",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/leadboxer-com-api-openapi.yml#/components/schemas/CustomTrackingDomainValidationResponse",
  "type": "object",
  "properties": {
    "responseCode": {
      "type": "integer",
      "format": "int32"
    },
    "responseMessage": {
      "type": "string"
    },
    "messageType": {
      "type": "string",
      "description": "Indicates the result of custom tracking domain validation.\n\n- ERROR: Validation failed due to a client-side or server-side error.\n- WARNING: The domain is valid, but the DNS configuration is incomplete. Suggested CNAME records are returned.\n- SUCCESS: The domain is valid and correctly configured for tracking."
    },
    "suggestions": {
      "type": "array",
      "description": "Recommended DNS record configurations needed to complete custom tracking domain setup.",
      "items": {
        "$ref": "#/$defs/CTDSuggestionDTO"
      }
    }
  },
  "$defs": {
    "CTDSuggestionDTO": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "The DNS record type that should be configured for the custom tracking domain. This is typically a CNAME record required for tracking and link redirection."
        },
        "host": {
          "type": "string",
          "description": "Tracking subdomain where the DNS record should be configured."
        },
        "value": {
          "type": "string",
          "description": "Target hostname that the tracking subdomain must point to."
        }
      },
      "description": "A recommended DNS record configuration generated after validating the custom tracking domain"
    }
  }
}