{"componentChunkName":"component---src-templates-api-js","path":"/api/tracking-domains/","result":{"data":{"allApiBlueprint":{"edges":[{"node":{"meta":{"title":"A/B Testing API","label":"New"},"fields":{"path":"/api/ab-testing/","file":"ab-testing.apib"}}},{"node":{"meta":{"title":"Data Privacy API","label":"New"},"fields":{"path":"/api/data-privacy/","file":"data-privacy.apib"}}},{"node":{"meta":{"title":"Events API","label":null},"fields":{"path":"/api/events/","file":"events.apib"}}},{"node":{"meta":{"title":"Ingest API","label":"Private Access"},"fields":{"path":"/api/events-ingest/","file":"events-ingest.apib"}}},{"node":{"meta":{"title":"Inbound Domains API","label":null},"fields":{"path":"/api/inbound-domains/","file":"inbound-domains.apib"}}},{"node":{"meta":{"title":"Account API","label":null},"fields":{"path":"/api/account/","file":"account.apib"}}},{"node":{"meta":{"title":"API Overview","label":null},"fields":{"path":"/api/","file":"index.apib"}}},{"node":{"meta":{"title":"Automatic Inline Seeding","label":"Deliverability"},"fields":{"path":"/api/inline-seeds/","file":"inline-seeds.apib"}}},{"node":{"meta":{"title":"Labs APIs","label":null},"fields":{"path":"/api/labs/","file":"labs.apib"}}},{"node":{"meta":{"title":"Message Events API","label":null},"fields":{"path":"/api/message-events/","file":"message-events.apib"}}},{"node":{"meta":{"title":"Recipient Validation API","label":"New"},"fields":{"path":"/api/recipient-validation/","file":"recipient-validation.apib"}}},{"node":{"meta":{"title":"IP Pools API","label":null},"fields":{"path":"/api/ip-pools/","file":"ip-pools.apib"}}},{"node":{"meta":{"title":"Seed List API","label":"Deliverability"},"fields":{"path":"/api/seed-list/","file":"seed-list.apib"}}},{"node":{"meta":{"title":"Bounce Domains API","label":null},"fields":{"path":"/api/bounce-domains/","file":"bounce-domains.apib"}}},{"node":{"meta":{"title":"Recipient Lists API","label":null},"fields":{"path":"/api/recipient-lists/","file":"recipient-lists.apib"}}},{"node":{"meta":{"title":"Sending IPs API","label":null},"fields":{"path":"/api/sending-ips/","file":"sending-ips.apib"}}},{"node":{"meta":{"title":"Relay Webhooks API","label":null},"fields":{"path":"/api/relay-webhooks/","file":"relay-webhooks.apib"}}},{"node":{"meta":{"title":"SMTP API","label":null},"fields":{"path":"/api/smtp/","file":"smtp.apib"}}},{"node":{"meta":{"title":"Snippets API","label":"New"},"fields":{"path":"/api/snippets/","file":"snippets.apib"}}},{"node":{"meta":{"title":"Subaccounts API","label":null},"fields":{"path":"/api/subaccounts/","file":"subaccounts.apib"}}},{"node":{"meta":{"title":"Sending Domains API","label":null},"fields":{"path":"/api/sending-domains/","file":"sending-domains.apib"}}},{"node":{"meta":{"title":"Suppression List API","label":null},"fields":{"path":"/api/suppression-list/","file":"suppression-list.apib"}}},{"node":{"meta":{"title":"Template Language","label":null},"fields":{"path":"/api/template-language/","file":"template-language.apib"}}},{"node":{"meta":{"title":"Tracking Domains API","label":null},"fields":{"path":"/api/tracking-domains/","file":"tracking-domains.apib"}}},{"node":{"meta":{"title":"Templates API","label":null},"fields":{"path":"/api/templates/","file":"templates.apib"}}},{"node":{"meta":{"title":"Transmissions API","label":null},"fields":{"path":"/api/transmissions/","file":"transmissions.apib"}}},{"node":{"meta":{"title":"Event Webhooks API","label":null},"fields":{"path":"/api/webhooks/","file":"webhooks.apib"}}},{"node":{"meta":{"title":"Usage API","label":null},"fields":{"path":"/api/usage/","file":"usage.apib"}}},{"node":{"meta":{"title":"Metrics API","label":null},"fields":{"path":"/api/metrics/","file":"metrics.apib"}}}]},"apiBlueprint":{"ast":{"element":"parseResult","content":[{"element":"category","meta":{"classes":{"element":"array","content":[{"element":"string","content":"api"}]},"title":{"element":"string","content":""}},"attributes":{"meta":{"element":"array","content":[{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"FORMAT"},"value":{"element":"string","content":"1A"}}},{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"title"},"value":{"element":"string","content":"Tracking Domains API"}}},{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"description"},"value":{"element":"string","content":"Manage tracking domains, which are used to wrap links in engagement tracking to report opens and clicks in your emails."}}}]}},"content":[{"element":"category","meta":{"classes":{"element":"array","content":[{"element":"string","content":"resourceGroup"}]},"title":{"element":"string","content":"Tracking Domains"}},"content":[{"element":"copy","content":"Tracking domains are used in engagement tracking to report email opens and link clicks.\nThey wrap the open pixel and all links in your emails.\nWhen clicked, these links report the event to SparkPost, then quickly forward to the intended destination.\nBy default, the tracking domain on your account is `spgo.io` (`eu.spgo.io` for EU accounts). This API allows you to set up and manage custom tracking domains.\nYou can also set one up from <a href=\"https://app.sparkpost.com/account/tracking-domains/create\" target=\"_blank\">your account</a> (<a href=\"https://app.eu.sparkpost.com/account/tracking-domains/create\" target=\"_blank\">EU</a>).\n\nAs an example, say your email contains this link:\n\n```html\n<a href=\"https://www.heml.io\">Build responsive emails</a>\n```\n\nIn order to track clicks on that link, we wrap it. The resulting HTML would look something like this:\n\n```html\n<a href=\"http://spgo.io/e/nInKCLCf9wnO2brop7RTsg...\">Build responsive emails</a>\n```\n\nWith a custom tracking domain you can replace the domain part of the link. So if your tracking domain was `click.heml.io`, your HTML would look like this:\n\n```html\n<a href=\"http://click.heml.io/e/nInKCLCf9wnO2brop7RTsg...\">Build responsive emails</a>\n```\n\n### Association to Sending Domains and Defaults\n\nIn order for a tracking domain to be used, it must be associated to a [sending domain](/api/sending-domains/) or set as a default.\nOnce that is done, templates and transmissions that have open or click tracking on will automatically use the domain to wrap links.\nIf a tracking domain is set as default, it will automatically be used with sending domains that aren't associated with a different tracking domain.\nDefault tracking domains do not override associated tracking domains. You can set a default for each subaccount as well.\nSparkPost picks the first tracking domain it can find to use in this order: 1. Associated tracking domain. 2. Subaccount default. 3. Account default.\n\n### DNS\n\nTracking domains need to be verified via DNS. You'll need to add a CNAME record to the domain's DNS settings before it can be used or set as the default. The CNAME value can change according to the account region or HTTPS support:\n\n| Service              | CNAME value                   | Supports Managed HTTPS | Supports HTTPS through CDN/Proxy |\n| -------------------- | ----------------------------- | ---------------------- | -------------------------------- |\n| SparkPost US V2      | `v2.spgo.io`                  | Yes                    | Yes                              |\n| SparkPost EU V2      | `eu.v2.spgo.io`               | Yes                    | Yes                              |\n| SparkPost US         | `spgo.io`                     | No                     | Yes                              |\n| SparkPost EU         | `eu.spgo.io`                  | No                     | Yes                              |\n| SparkPost Enterprise | `<tenant>.et.e.sparkpost.com` | No                     | Yes                              |\n\nFor more information and Enterprise settings <a target=\"_blank\" href=\"https://www.sparkpost.com/docs/tech-resources/enabling-multiple-custom-tracking-domains/\">go here</a>.\n\n### Security\n\nTracking domains use HTTP by default. When using the Tracking Domains API, HTTPS support must be explicitly enabled. For more information, see <a target=\"_blank\" href=\"https://support.sparkpost.com/docs/tech-resources/managed-https-for-tracking-domains\">this guide</a>.\n\n### Subaccounts\n\nTracking domains can only be assigned to subaccounts on creation. They cannot be re-assigned at a later point.\nIf assigned and verified, a tracking domain can also be set as the default for that subaccount.\nIn order to be associated to a subaccount's sending domain, a tracking domain has to be assigned to the same subaccount.\n\n## Tracking Domain Object\n\n<DataStructure id=\"efe090cedd8fe569e7bd2795a18439c6\"   sample=\"%7B%0A%20%20%20%20%22domain%22%3A%20%22example.domain.com%22%2C%0A%20%20%20%20%22port%22%3A%20443%2C%0A%20%20%20%20%22secure%22%3A%20true%2C%0A%20%20%20%20%22default%22%3A%20false%2C%0A%20%20%20%20%22uses_managed_certificate%22%3A%20true%2C%0A%20%20%20%20%22status%22%3A%20%7B%0A%20%20%20%20%20%20%20%20%22verified%22%3A%20false%2C%0A%20%20%20%20%20%20%20%20%22cname_status%22%3A%20%22pending%22%2C%0A%20%20%20%20%20%20%20%20%22compliance_status%22%3A%20%22pending%22%0A%20%20%20%20%7D%2C%0A%20%20%20%20%22tls_certificate%22%3A%20%7B%0A%20%20%20%20%20%20%20%20%22issued_at%22%3A%20%222026-01-27T19%3A09%3A17.000Z%22%2C%0A%20%20%20%20%20%20%20%20%22expires_at%22%3A%20%222026-04-27T19%3A09%3A16.000Z%22%2C%0A%20%20%20%20%20%20%20%20%22error_code%22%3A%20null%0A%20%20%20%20%7D%2C%0A%7D\"></DataStructure>"},{"element":"resource","meta":{"title":{"element":"string","content":"Create a Tracking Domain"}},"attributes":{"href":{"element":"string","content":"/v1/tracking-domains"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Create a Tracking Domain"}},"attributes":{"href":{"element":"string","content":"/v1/tracking-domains"}},"content":[{"element":"copy","content":"<DataStructure id=\"e496c2a4701b5c9abdbf8bff1642b394\"  ></DataStructure>"},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"domain\": \"example.domain.com\",\n      \"secure\": true\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"results\": {\n          \"domain\": \"example.domain.com\"\n      }\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"domain\": \"example.domain.com\",\n      \"secure\": true\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"400"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\" : [\n          {\n              \"param\" : \"domain\",\n              \"message\" : \"domain is on a DNS blacklist\",\n              \"value\": \"baddomain.com\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"domain\": \"example.domain.com\",\n      \"secure\": true\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"409"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\" : [\n          {\n              \"message\" : \"The tracking domain already exists\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"domain\": \"example.domain.com\",\n      \"secure\": true\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"422"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"param\": \"domain\",\n              \"message\": \"domain must be valid\",\n              \"value\": \"baddomain\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Verify a Tracking Domain"}},"attributes":{"href":{"element":"string","content":"/v1/tracking-domains/{domain}/verify"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Verify a Tracking Domain"}},"attributes":{"href":{"element":"string","content":"/v1/tracking-domains/{domain}/verify"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"domain"},"value":{"element":"string"}}}]}},"content":[{"element":"copy","content":"Initiate a check against the configured redirect for the specified tracking domain. The domain's `status` object is returned on success."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"results\": {\n          \"verified\": true,\n          \"cname_status\": \"\",\n          \"compliance_status\": \"valid\"\n      }\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"400"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"HTTP request to https://example.domain.com:443 failed.  Please verify that your redirect is functioning and that your SSL certificate is valid.\",\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"404"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"resource not found\"\n          }\n      ]\n  }\n\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Retrieve a Tracking Domain"}},"attributes":{"href":{"element":"string","content":"/v1/tracking-domains/{domain}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Retrieve a Tracking Domain"}},"attributes":{"href":{"element":"string","content":"/v1/tracking-domains/{domain}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"domain"},"value":{"element":"string"}}}]}},"content":[{"element":"copy","content":"Retrieve an existing tracking domain."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}},{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"results\": {\n          \"port\": 443,\n          \"domain\": \"example.domain.com\",\n          \"secure\": true,\n          \"default\": true,\n          \"status\": {\n              \"verified\": false,\n              \"cname_status\": \"pending\",\n              \"compliance_status\": \"pending\"\n          }\n      }\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}},{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"400"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"param\": \"domain\",\n              \"message\": \"domain must be valid\",\n              \"value\": \"baddomain\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}},{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"404"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"resource not found\"\n          }\n      ]\n  }\n\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Update a Tracking Domain"}},"attributes":{"href":{"element":"string","content":"/v1/tracking-domains/{domain}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Update a Tracking Domain"}},"attributes":{"href":{"element":"string","content":"/v1/tracking-domains/{domain}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"domain"},"value":{"element":"string"}}}]}},"content":[{"element":"copy","content":"Update the attributes of an existing tracking domain. The primary account and each subaccount can only have one default tracking domain.\nSetting a new default automatically unsets the current relevant default, if it exists.\n\n<DataStructure id=\"a2eab30a5c4b8fa836dca836ad44dae4\"  ></DataStructure>"},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"secure\": true,\n      \"default\": true\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"results\": {\n          \"domain\": \"example.domain.com\"\n      }\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"secure\": true,\n      \"default\": true\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"400"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"param\": \"domain\",\n              \"message\": \"domain must be valid\",\n              \"value\": \"baddomain\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"secure\": true,\n      \"default\": true\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"404"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"resource not found\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"secure\": true,\n      \"default\": true\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"422"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"Tracking domain 'example.domain.com' unverified.\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Check Certificate Eligibility"}},"attributes":{"href":{"element":"string","content":"/v1/tracking-domains/{domain}/certificate/check"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Check Certificate Eligibility"}},"attributes":{"href":{"element":"string","content":"/v1/tracking-domains/{domain}/certificate/check"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"domain"},"value":{"element":"string"}}}]}},"content":[{"element":"copy","content":"Check if a tracking domain is eligible for managed TLS certificates. This is a read-only operation that queries Let's Encrypt to determine if the domain can be used with SparkPost's managed HTTPS feature. Unlike the enable endpoint, this check can be performed on unverified domains and does not modify the tracking domain configuration.\n\nUse this endpoint before enabling managed certificates to confirm eligibility and avoid potential failures.\n\nFor more information, see the <a target=\"_blank\" href=\"https://support.sparkpost.com/docs/tech-resources/managed-https-for-tracking-domains\">Managed HTTPS guide</a>."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"results\": {\n          \"domain\": \"example.domain.com\",\n          \"supportsManagedCertificate\": true\n      }\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"400"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"Certificate eligibility check failed\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"403"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"Domain is not eligible for managed certificates due to Let's Encrypt policies\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"404"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"resource not found\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"503"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"Certificate eligibility check timed out\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Enable Managed Certificate"}},"attributes":{"href":{"element":"string","content":"/v1/tracking-domains/{domain}/certificate/enable"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Enable Managed Certificate"}},"attributes":{"href":{"element":"string","content":"/v1/tracking-domains/{domain}/certificate/enable"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"domain"},"value":{"element":"string"}}}]}},"content":[{"element":"copy","content":"Enable managed TLS certificate for an existing tracking domain. This initiates the certificate issuance process using Let's Encrypt. The domain must be verified and point to a V2 endpoint (`v2.spgo.io` or `eu.v2.spgo.io`) before enabling managed certificates. Once enabled, SparkPost will automatically issue and renew TLS certificates for the domain.\n\nAfter receiving a successful response, monitor the domain's `status.tls_status` field to track the certificate issuance progress. The TLS status will change from `pending` to `valid` once the certificate is successfully issued. Other TLS-related fields will also be updated automatically: `uses_managed_certificate` and `secure` will be set to true, and `port` will be set to 443.\n\nFor more information, see the <a target=\"_blank\" href=\"https://support.sparkpost.com/docs/tech-resources/managed-https-for-tracking-domains\">Managed HTTPS guide</a>."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"results\": {\n          \"message\": \"Certificate issuance initiated for example.domain.com\"\n      }\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"400"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"Domain must be verified before enabling managed certificates\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"403"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"Managed certificates cannot be issued for this domain due to Let's Encrypt policies\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"404"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"resource not found\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"503"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"Certificate eligibility check timed out\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Delete a Tracking Domain"}},"attributes":{"href":{"element":"string","content":"/v1/tracking-domains/{domain}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Delete a Tracking Domain"}},"attributes":{"href":{"element":"string","content":"/v1/tracking-domains/{domain}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"domain"},"value":{"element":"string"}}}]}},"content":[{"element":"copy","content":"Delete an existing tracking domain."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"DELETE"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"204"}}}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"DELETE"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"400"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"param\": \"domain\",\n              \"message\": \"domain must be valid\",\n              \"value\": \"baddomain\"\n          }\n      ]\n  }\n\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"DELETE"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"404"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"resource not found\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"List All Tracking Domains"}},"attributes":{"href":{"element":"string","content":"/v1/tracking-domains{?default,subaccounts}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"List All Tracking Domains"}},"attributes":{"href":{"element":"string","content":"/v1/tracking-domains{?default,subaccounts}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"description":{"element":"string","content":"Restrict results to default domains when true and non-default domains when false."},"title":{"element":"string","content":"boolean"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"default"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Comma delimited list of subaccounts to include in results."},"title":{"element":"string","content":"list"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"subaccounts"},"value":{"element":"string"}}}]}},"content":[{"element":"copy","content":"Returns an array with all tracking domains. Each item in the array is a full tracking domain object."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}},{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"results\": [\n          {\n              \"port\": 443,\n              \"domain\": \"example.domain.com\",\n              \"secure\": true,\n              \"default\": true,\n              \"status\": {\n                  \"verified\": false,\n                  \"cname_status\": \"pending\",\n                  \"compliance_status\": \"pending\"\n              }\n          },\n          {\n              \"port\": 80,\n              \"domain\": \"example2.domain.com\",\n              \"secure\": false,\n              \"default\": false,\n              \"status\": {\n                  \"verified\": true,\n                  \"cname_status\": \"valid\",\n                  \"compliance_status\": \"valid\"\n              },\n              \"subaccount_id\": 215\n          }\n      ]\n  }\n"}]}]}]}]}]},{"element":"category","meta":{"classes":{"element":"array","content":[{"element":"string","content":"dataStructures"}]}},"content":[{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"efe090cedd8fe569e7bd2795a18439c6"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Name of the tracking domain."}},"content":{"key":{"element":"string","content":"domain"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"The port used when constructing the tracking URL. `80` if secure is `false`, `443` if secure is `true`."}},"content":{"key":{"element":"string","content":"port"},"value":{"element":"number"}}},{"element":"member","meta":{"description":{"element":"string","content":"Whether the tracking URL should use HTTPS. HTTP will be used if `false`."}},"content":{"key":{"element":"string","content":"secure"},"value":{"element":"boolean","attributes":{"default":{"element":"boolean","content":false}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Whether the tracking domain should be used when not explicitly associated with a sending domain. Only one default domain per account and subaccount can be set. The domain has to be verified to be set as the default."}},"content":{"key":{"element":"string","content":"default"},"value":{"element":"boolean","attributes":{"default":{"element":"boolean","content":false}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Contains status details like verification, DNS and TLS."}},"content":{"key":{"element":"string","content":"status"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"Whether the domain's ownership has been verified. `true` if cname_status is `valid`."}},"content":{"key":{"element":"string","content":"verified"},"value":{"element":"boolean"}}},{"element":"member","meta":{"description":{"element":"string","content":"Verification status of CNAME record configuration."}},"content":{"key":{"element":"string","content":"cname_status"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"string","content":"unverified"},{"element":"string","content":"pending"},{"element":"string","content":"invalid"},{"element":"string","content":"valid"}]}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Status of the domain's compliance review."}},"content":{"key":{"element":"string","content":"compliance_status"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"string","content":"pending"},{"element":"string","content":"valid"},{"element":"string","content":"blocked"}]}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Status of the domain's TLS management."}},"content":{"key":{"element":"string","content":"tls_status"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"string","content":"unknown"},{"element":"string","content":"unavailable"},{"element":"string","content":"pending"},{"element":"string","content":"failed"},{"element":"string","content":"expired"},{"element":"string","content":"valid"}]}}}}}]}}},{"element":"member","meta":{"description":{"element":"string","content":"ID of the subaccount the tracking domain is assigned to. Not returned unless set and can only be set on creation."}},"content":{"key":{"element":"string","content":"subaccount_id"},"value":{"element":"number"}}},{"element":"member","meta":{"description":{"element":"string","content":"Whether a managed TLS certificate should be enabled for the domain. <a target=\"_blank\" href=\"https://support.sparkpost.com/docs/tech-resources/managed-https-for-tracking-domains\">Read more</a>"}},"content":{"key":{"element":"string","content":"uses_managed_certificate"},"value":{"element":"boolean"}}},{"element":"member","meta":{"description":{"element":"string","content":"Contains details about the managed TLS certificate attached to the domain if present."}},"content":{"key":{"element":"string","content":"tls_certificate"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"ISO date of certificate issuance."}},"content":{"key":{"element":"string","content":"issued_at"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"ISO date of certificate expiration."}},"content":{"key":{"element":"string","content":"expires_at"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Error encountered during the last issuance or renewal process."}},"content":{"key":{"element":"string","content":"error_code"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"string","content":"null"},{"element":"string","content":"acme:rejected_identifier"},{"element":"string","content":"acme:dns"},{"element":"string","content":"acme:unauthorized"},{"element":"string","content":"acme:temporary"},{"element":"string","content":"service:internal"}]}}}}}]}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"e496c2a4701b5c9abdbf8bff1642b394"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Name of the tracking domain."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"domain"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Whether the tracking URL should use HTTPS. HTTP will be used if `false`."}},"content":{"key":{"element":"string","content":"secure"},"value":{"element":"boolean","attributes":{"default":{"element":"boolean","content":false}}}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"a2eab30a5c4b8fa836dca836ad44dae4"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Whether the tracking URL should use HTTPS. HTTP will be used if `false`."}},"content":{"key":{"element":"string","content":"secure"},"value":{"element":"boolean"}}},{"element":"member","meta":{"description":{"element":"string","content":"Whether the tracking domain should be used when not explicitly associated with a sending domain. The domain has to be verified to be set as the default."}},"content":{"key":{"element":"string","content":"default"},"value":{"element":"boolean"}}}]}}]}]},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":3},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":6653},{"element":"number","content":68}]}]}]}},"content":"unable to parse additional parameter traits, expected '([required | optional], [<type>], [`<example value>`])', e.g. '(optional, string, `Hello World`)'"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":3},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":7797},{"element":"number","content":68}]}]}]}},"content":"unable to parse additional parameter traits, expected '([required | optional], [<type>], [`<example value>`])', e.g. '(optional, string, `Hello World`)'"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":3},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":9464},{"element":"number","content":68}]}]}]}},"content":"unable to parse additional parameter traits, expected '([required | optional], [<type>], [`<example value>`])', e.g. '(optional, string, `Hello World`)'"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":2},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":9078},{"element":"number","content":66}]}]}]}},"content":"the resource '/v1/tracking-domains/{domain}' is already defined"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":3},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":11502},{"element":"number","content":68}]}]}]}},"content":"unable to parse additional parameter traits, expected '([required | optional], [<type>], [`<example value>`])', e.g. '(optional, string, `Hello World`)'"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":3},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":13992},{"element":"number","content":68}]}]}]}},"content":"unable to parse additional parameter traits, expected '([required | optional], [<type>], [`<example value>`])', e.g. '(optional, string, `Hello World`)'"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":3},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":15610},{"element":"number","content":68}]}]}]}},"content":"unable to parse additional parameter traits, expected '([required | optional], [<type>], [`<example value>`])', e.g. '(optional, string, `Hello World`)'"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":2},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":15482},{"element":"number","content":69}]}]}]}},"content":"the resource '/v1/tracking-domains/{domain}' is already defined"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":5},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":18046},{"element":"number","content":67}]}]}]}},"content":"ignoring unrecognized type attribute"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":5},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":20211},{"element":"number","content":77}]}]}]}},"content":"ignoring unrecognized type attribute"}]},"TableOfContents":[{"anchor":"#tracking-domains","title":"Tracking Domains","children":[{"anchor":"#header-association-to-sending-domains-and-defaults","title":"Association to Sending Domains and Defaults"},{"anchor":"#header-dns","title":"DNS"},{"anchor":"#header-security","title":"Security"},{"anchor":"#header-subaccounts","title":"Subaccounts"},{"anchor":"#header-tracking-domain-object","title":"Tracking Domain Object"},{"anchor":"#tracking-domains-create-a-tracking-domain","title":"Create a Tracking Domain","children":[{"anchor":"#tracking-domains-post-create-a-tracking-domain","title":"Create a Tracking Domain"}]},{"anchor":"#tracking-domains-verify-a-tracking-domain","title":"Verify a Tracking Domain","children":[{"anchor":"#tracking-domains-post-verify-a-tracking-domain","title":"Verify a Tracking Domain"}]},{"anchor":"#tracking-domains-retrieve-a-tracking-domain","title":"Retrieve a Tracking Domain","children":[{"anchor":"#tracking-domains-get-retrieve-a-tracking-domain","title":"Retrieve a Tracking Domain"}]},{"anchor":"#tracking-domains-update-a-tracking-domain","title":"Update a Tracking Domain","children":[{"anchor":"#tracking-domains-put-update-a-tracking-domain","title":"Update a Tracking Domain"}]},{"anchor":"#tracking-domains-check-certificate-eligibility","title":"Check Certificate Eligibility","children":[{"anchor":"#tracking-domains-post-check-certificate-eligibility","title":"Check Certificate Eligibility"}]},{"anchor":"#tracking-domains-enable-managed-certificate","title":"Enable Managed Certificate","children":[{"anchor":"#tracking-domains-post-enable-managed-certificate","title":"Enable Managed Certificate"}]},{"anchor":"#tracking-domains-delete-a-tracking-domain","title":"Delete a Tracking Domain","children":[{"anchor":"#tracking-domains-delete-delete-a-tracking-domain","title":"Delete a Tracking Domain"}]},{"anchor":"#tracking-domains-list-all-tracking-domains","title":"List All Tracking Domains","children":[{"anchor":"#tracking-domains-get-list-all-tracking-domains","title":"List All Tracking Domains"}]}]}],"meta":{"title":"Tracking Domains API","description":"Manage tracking domains, which are used to wrap links in engagement tracking to report opens and clicks in your emails.","full":false},"fields":{"path":"/api/tracking-domains/"}}},"pageContext":{"file":"tracking-domains.apib"}},"staticQueryHashes":["1319884646","1428769721","3859448388"]}