{"componentChunkName":"component---src-templates-api-js","path":"/api/sending-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":"Sending Domains API"}}},{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"description"},"value":{"element":"string","content":"Manage sending domains, which are used to indicate who an email is from."}}}]}},"content":[{"element":"category","meta":{"classes":{"element":"array","content":[{"element":"string","content":"resourceGroup"}]},"title":{"element":"string","content":"Sending Domains"}},"content":[{"element":"copy","content":"A sending domain is a domain that is used to indicate who an email is from via the \"From:\" header. DNS records can be configured for a sending domain, which allows recipient mail servers to authenticate your messages.\n\n<Banner status=\"success\"><strong>For maximum deliverability</strong>, we recommend <a href=\"#sending-domains-post-verify-a-sending-domain\">configuring</a> DKIM for your sending domains <em>and</em> <a href=\"https://www.sparkpost.com/docs/tech-resources/custom-bounce-domain/\">configuring a bounce domain</a> on corresponding subdomains. This is an easy way to help mailbox providers authenticate and differentiate your email from other senders using SparkPost.</Banner>\n\n### DNS notes\n\n**DKIM**\n\n<Banner status=\"info\">These requirements are only important to note if you are generating your own DKIM values.</Banner>\n\n-   Both PKCS #1 and PKCS #8 formats are supported.\n\n-   We do not support password-protected keys.\n\n-   The DKIM public/private key pair must match a single format as the API will reject mismatching pairs.\n\n-   Public key verification requires the following:\n    -   A valid DKIM record must be in the DNS for the sending domain being verified.\n    -   The record must use the sending domain's public key in the `p=` tag.\n    -   If a `k=` tag is defined, it must be set to `rsa`.\n    -   If an `h=` tag is defined, it must be set to `sha256`.\n\n**CNAME**\n\nCNAME verification requires a valid CNAME record in DNS pointed at the appropriate SparkPost domain.\n\nFor SparkPost:\n\n| Hostname    | Type  | Value              |\n| ----------- | ----- | ------------------ |\n| example.com | CNAME | sparkpostmail‍.com |\n\nFor SparkPost EU:\n\n| Hostname    | Type  | Value                 |\n| ----------- | ----- | --------------------- |\n| example.com | CNAME | eu.sparkpostmail‍.com |\n\nFor Enterprise accounts:\n\n| Hostname     | Type  | Value                                       |\n| ------------ | ----- | ------------------------------------------- |\n| example.‍com | CNAME | &lt;public_tenant_id>.mail.e.sparkpost‍.com |\n\n**MX**\n\nMX verification is only available to <strong>Enterprise</strong> accounts. Please contact your TAM if you want to verify your domain with MX.\n\n### Using a sending domain as a bounce domain\n\nBounce domains are used to report bounces – emails that were rejected from the recipient server. By setting the bounce domain, you're customizing the address that is used for the `Return-Path` header, which is the destination for out of band (OOB) bounces.\n\nA sending domain can be used as a bounce domain if it is verified via the following the methods:\n\n-   CNAME record\n\n-   MX records (<span class=\"label label-warning\"><strong>Enterprise</strong></span> only).\n\nOnce it is verified through one of those two methods, you can use it as a bounce domain by including it as a transmission's `return_path` field or SMTP's `MAIL FROM` email address. For additional details on custom bounce domains, please see this [support article](https://www.sparkpost.com/docs/tech-resources/custom-bounce-domain/).\n\n## Sending Domain Object\n\n<DataStructure id=\"7e0f1bb25eb7f82ba15e8594bfee0363\"  title=\"Attributes\"  sample=\"%7B%0A%20%20%20%20%22domain%22%3A%20%22example1.com%22%2C%0A%20%20%20%20%22tracking_domain%22%3A%20%22click.example1.com%22%2C%0A%20%20%20%20%22status%22%3A%20%7B%0A%20%20%20%20%20%20%20%20%22ownership_verified%22%3A%20true%2C%0A%20%20%20%20%20%20%20%20%22spf_status%22%3A%20%22unverified%22%2C%0A%20%20%20%20%20%20%20%20%22abuse_at_status%22%3A%20%22unverified%22%2C%0A%20%20%20%20%20%20%20%20%22dkim_status%22%3A%20%22valid%22%2C%0A%20%20%20%20%20%20%20%20%22cname_status%22%3A%20%22valid%22%2C%0A%20%20%20%20%20%20%20%20%22mx_status%22%3A%20%22unverified%22%2C%0A%20%20%20%20%20%20%20%20%22compliance_status%22%3A%20%22valid%22%2C%0A%20%20%20%20%20%20%20%20%22postmaster_at_status%22%3A%20%22unverified%22%2C%0A%20%20%20%20%20%20%20%20%22verification_mailbox_status%22%3A%20%22valid%22%2C%0A%20%20%20%20%20%20%20%20%22verification_mailbox%22%3A%20%22susan.calvin%22%0A%20%20%20%20%7D%2C%0A%20%20%20%20%22shared_with_subaccounts%22%3A%20false%2C%0A%20%20%20%20%22is_default_bounce_domain%22%3A%20false%0A%7D\"></DataStructure>"},{"element":"resource","meta":{"title":{"element":"string","content":"Create a Sending Domain"}},"attributes":{"href":{"element":"string","content":"/v1/sending-domains"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Create a Sending Domain"}},"attributes":{"href":{"element":"string","content":"/v1/sending-domains"}},"content":[{"element":"copy","content":"Creates a new sending domain. Each domain and its subdomains can only be added to a single account.\n\n<Banner status=\"warning\"><strong>Note</strong>: When adding a sending domain to your account, the domain must be verified within two weeks or it will be removed from your account.</Banner>\n\n<DataStructure id=\"5761b8f246fbc78097f6d2038d7f67fc\"  ></DataStructure>\n\nReturns the domain and a success message. If `generate_dkim` was true, the dkim object is also returned.\n\nIn case the sending domain gets blocked due to compliance validations, an HTTP 400 response is returned along with the error code, description and message with the reason for the blocking. A few examples are provided in the response section."},{"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\": \"example1.com\",\n      \"tracking_domain\": \"click.example1.com\",\n      \"shared_with_subaccounts\": false\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          \"message\": \"Successfully Created domain.\",\n          \"domain\": \"example1.com\",\n          \"dkim\": {\n              \"public\": \"MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC+W6scd3XWwvC/hPRksfDYFi3ztgyS9OSqnnjtNQeDdTSD1DRx/xFar2wjmzxp2+SnJ5pspaF77VZveN3P/HVmXZVghr3asoV9WBx/uW1nDIUxU35L4juXiTwsMAbgMyh3NqIKTNKyMDy4P8vpEhtH1iv/BrwMdBjHDVCycB8WnwIDAQAB\",\n              \"selector\": \"scph0316\",\n              \"signing_domain\": \"example1.com\",\n              \"headers\": \"from:to:subject:date\"\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\": \"example1.com\",\n      \"tracking_domain\": \"click.example1.com\",\n      \"shared_with_subaccounts\": false\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              \"code\": \"7000\",\n              \"description\": \"Please contact SparkPost support to get this domain authorized for your account.\",\n              \"message\": \"Restricted domain\"\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\": \"example1.com\",\n      \"tracking_domain\": \"click.example1.com\",\n      \"shared_with_subaccounts\": false\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              \"code\": \"7004\",\n              \"description\": \"Please contact SparkPost support to check about this org-domain availability.\",\n              \"message\": \"Domain in use by another account\"\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\": \"example1.com\",\n      \"tracking_domain\": \"click.example1.com\",\n      \"shared_with_subaccounts\": false\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              \"message\": \"invalid params\",\n              \"description\": \"Tracking domain 'click.example1.com' is not a registered tracking domain\",\n              \"code\": \"1200\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Verify a Sending Domain"}},"attributes":{"href":{"element":"string","content":"/v1/sending-domains/{domain}/verify"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Verify a Sending Domain"}},"attributes":{"href":{"element":"string","content":"/v1/sending-domains/{domain}/verify"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"domain"},"value":{"element":"string","content":"example1.com"}}}]}},"content":[{"element":"copy","content":"<DataStructure id=\"25f81792bd1889c67abdf53580cf9ffc\"  ></DataStructure>\n\n<Banner status=\"info\"><strong><a href=\"https://www.sparkpost.com/enterprise-email/\">Enterprise</a></strong> accounts: Depending on your setup, sending domains might be verified automatically when they are created, and can be used to send immediately. In that case, there is no need separately verify sending domains. To find out if this applies to you, ask your TAM.\n</Banner>\n\n#### Verify via DNS\n\nTo verify your DKIM or CNAME, include `dkim_verify` or `cname_verify` in the request. SparkPost will check against and verify the associated DNS record type for the specified sending domain.\n\nThe request will return an extra attribute, `dns`, which contains the DNS values or error if there was a problem validating the either the DKIM or CNAME.\n\n##### DNS Object\n\n<DataStructure id=\"cfacff45ac544d6e43cfb9765b5afac2\"  title=\"Attributes\" ></DataStructure>\n\n#### Verify via mailbox\n\nIf you can't update your DNS records for a sending domain, you can verify your domain through a mailbox you control. SparkPost will send an email with a verification link to the specified mailbox. Once the link is clicked, you will be able to send email from this domain, but SparkPost will not be able to DKIM-sign the mail it sends on your behalf, which could cause deliverability issues. **For this reason, we highly recommend using DNS verification whenever possible.**\n\n##### Trigger a verification email\n\nIncluding `postmaster_at_verify`, `abuse_at_verify`, or `verification_mailbox_verify` in the request triggers an email sent to the corresponding mailbox with the verification link. When using `verification_mailbox_verify`, the email is sent to the mailbox set in `verification_mailbox`.\n\nFor `postmaster_at_verify`, `abuse_at_verify` and `verification_mailbox_verify` ownership verification, if the request is made a second time, another email will be sent with a new verification link. If the link in the previously sent message is clicked it won't verify domain ownership.\n\n##### Validate the verification token\n\nIncluding `verification_mailbox_token`, `postmaster_at_token`, or `abuse_at_token` in the request checks of the provided token matches the token sent in the email. If it does, the sending domain is verified.\n\n_This is handled automatically through the SparkPost app._\n\n#### Returns\n\nReturns the `status` object along with the [`dns`](#header-dns-object) property, if `dkim_verify` or `cname_verify` was set."},{"element":"httpTransaction","content":[{"element":"httpRequest","meta":{"title":{"element":"string","content":"Verify DKIM"}},"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      \"dkim_verify\": 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          \"ownership_verified\": true,\n          \"dns\": {\n              \"dkim_record\": \"k=rsa; h=sha256; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC+W6scd3XWwvC/hPRksfDYFi3ztgyS9OSqnnjtNQeDdTSD1DRx/xFar2wjmzxp2+SnJ5pspaF77VZveN3P/HVmXZVghr3asoV9WBx/uW1nDIUxU35L4juXiTwsMAbgMyh3NqIKTNKyMDy4P8vpEhtH1iv/BrwMdBjHDVCycB8WnwIDAQAB\"\n          },\n          \"dkim_status\": \"valid\",\n          \"cname_status\": \"unverified\",\n          \"mx_status\": \"unverified\",\n          \"compliance_status\": \"valid\",\n          \"spf_status\": \"unverified\",\n          \"abuse_at_status\": \"unverified\",\n          \"postmaster_at_status\": \"unverified\",\n          \"verification_mailbox_status\": \"unverified\"\n      }\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","meta":{"title":{"element":"string","content":"Initiate anyone@ email"}},"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      \"verification_mailbox_verify\": true,\n      \"verification_mailbox\": \"susan.calvin\"\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          \"ownership_verified\": false,\n          \"spf_status\": \"unverified\",\n          \"compliance_status\": \"valid\",\n          \"dkim_status\": \"unverified\",\n          \"abuse_at_status\": \"unverified\",\n          \"postmaster_at_status\": \"unverified\",\n          \"verification_mailbox_status\": \"unverified\",\n          \"verification_mailbox\": \"susan.calvin\"\n      }\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Retrieve a Sending Domain"}},"attributes":{"href":{"element":"string","content":"/v1/sending-domains/{domain}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Retrieve a Sending Domain"}},"attributes":{"href":{"element":"string","content":"/v1/sending-domains/{domain}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"domain"},"value":{"element":"string","content":"example1.com"}}}]}},"content":[{"element":"copy","content":"Returns the full sending domain object, except the `domain` field."},{"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          \"tracking_domain\": \"click.example1.com\",\n          \"status\": {\n              \"ownership_verified\": false,\n              \"spf_status\": \"unverified\",\n              \"abuse_at_status\": \"unverified\",\n              \"dkim_status\": \"unverified\",\n              \"cname_status\": \"unverified\",\n              \"mx_status\": \"pending\",\n              \"compliance_status\": \"valid\",\n              \"postmaster_at_status\": \"unverified\",\n              \"verification_mailbox_status\": \"unverified\"\n          },\n          \"dkim\": {\n              \"headers\": \"from:to:subject:date\",\n              \"public\": \"MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC+W6scd3XWwvC/hPRksfDYFi3ztgyS9OSqnnjtNQeDdTSD1DRx/xFar2wjmzxp2+SnJ5pspaF77VZveN3P/HVmXZVghr3asoV9WBx/uW1nDIUxU35L4juXiTwsMAbgMyh3NqIKTNKyMDy4P8vpEhtH1iv/BrwMdBjHDVCycB8WnwIDAQAB\",\n              \"selector\": \"hello_selector\"\n          },\n          \"shared_with_subaccounts\": false,\n          \"is_default_bounce_domain\" : false\n      }\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Update a Sending Domain"}},"attributes":{"href":{"element":"string","content":"/v1/sending-domains/{domain}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Update a Sending Domain"}},"attributes":{"href":{"element":"string","content":"/v1/sending-domains/{domain}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"domain"},"value":{"element":"string","content":"example1.com"}}}]}},"content":[{"element":"copy","content":"<DataStructure id=\"ead910e77c7765cef31a1036c8ec8e05\"  ></DataStructure>"},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"},"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     \"tracking_domain\": \"click.example1.com\",\n     \"dkim\": {\n         \"private\": \"MIICXgIBAAKBgQC+W6scd3XWwvC/hPRksfDYFi3ztgyS9OSqnnjtNQeDdTSD1DRx/xFar2wjmzxp2+SnJ5pspaF77VZveN3P/HVmXZVghr3asoV9WBx/uW1nDIUxU35L4juXiTwsMAbgMyh3NqIKTNKyMDy4P8vpEhtH1iv/BrwMdBjHDVCycB8WnwIDAQABAoGBAITb3BCRPBi5lGhHdn+1RgC7cjUQEbSb4eFHm+ULRwQ0UIPWHwiVWtptZ09usHq989fKp1g/PfcNzm8c78uTS6gCxfECweFCRK6EdO6cCCr1cfWvmBdSjzYhODUdQeyWZi2ozqd0FhGWoV4VHseh4iLj36DzleTLtOZj3FhAo1WJAkEA68T+KkGeDyWwvttYtuSiQCCTrXYAWTQnkIUxduCp7Ap6tVeIDn3TaXTj74UbEgaNgLhjG4bX//fdeDW6PaK9YwJBAM6xJmwHLPMgwNVjiz3u/6fhY3kaZTWcxtMkXCjh1QE82KzDwqyrCg7EFjTtFysSHCAZxXZMcivGl4TZLHnydJUCQQCx16+M+mAatuiCnvxlQUMuMiSTNK6Amzm45u9v53nlZeY3weYMYFdHdfe1pebMiwrT7MI9clKebz6svYJVmdtXAkApDAc8VuR3WB7TgdRKNWdyGJGfoD1PO1ZE4iinOcoKV+IT1UCY99Kkgg6C7j62n/8T5OpRBvd5eBPpHxP1F9BNAkEA5Nf2VO9lcTetksHdIeKK+F7sio6UZn0Rv7iUo3ALrN1D1cGfWIh/Y1g==\",\n         \"public\": \"MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC+W6scd3XWwvC/hPRksfDYFi3ztgyS9OSqnnjtNQeDdTSD1DRx/xFar2wjmzxp2+SnJ5pspaF77VZveN3P/HVmXZVghr3asoV9WBx/uW1nDIUxU35L4juXiTwsMAbgMyh3NqIKTNKyMDy4P8vpEhtH1iv/BrwMdBjHDVCycB8WnwIDAQAB\",\n         \"selector\": \"hello_selector\"\n     },\n     \"is_default_bounce_domain\": 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          \"message\": \"Successfully Updated Domain.\",\n          \"domain\": \"example1.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":"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     \"tracking_domain\": \"click.example1.com\",\n     \"dkim\": {\n         \"private\": \"MIICXgIBAAKBgQC+W6scd3XWwvC/hPRksfDYFi3ztgyS9OSqnnjtNQeDdTSD1DRx/xFar2wjmzxp2+SnJ5pspaF77VZveN3P/HVmXZVghr3asoV9WBx/uW1nDIUxU35L4juXiTwsMAbgMyh3NqIKTNKyMDy4P8vpEhtH1iv/BrwMdBjHDVCycB8WnwIDAQABAoGBAITb3BCRPBi5lGhHdn+1RgC7cjUQEbSb4eFHm+ULRwQ0UIPWHwiVWtptZ09usHq989fKp1g/PfcNzm8c78uTS6gCxfECweFCRK6EdO6cCCr1cfWvmBdSjzYhODUdQeyWZi2ozqd0FhGWoV4VHseh4iLj36DzleTLtOZj3FhAo1WJAkEA68T+KkGeDyWwvttYtuSiQCCTrXYAWTQnkIUxduCp7Ap6tVeIDn3TaXTj74UbEgaNgLhjG4bX//fdeDW6PaK9YwJBAM6xJmwHLPMgwNVjiz3u/6fhY3kaZTWcxtMkXCjh1QE82KzDwqyrCg7EFjTtFysSHCAZxXZMcivGl4TZLHnydJUCQQCx16+M+mAatuiCnvxlQUMuMiSTNK6Amzm45u9v53nlZeY3weYMYFdHdfe1pebMiwrT7MI9clKebz6svYJVmdtXAkApDAc8VuR3WB7TgdRKNWdyGJGfoD1PO1ZE4iinOcoKV+IT1UCY99Kkgg6C7j62n/8T5OpRBvd5eBPpHxP1F9BNAkEA5Nf2VO9lcTetksHdIeKK+F7sio6UZn0Rv7iUo3ALrN1D1cGfWIh/Y1g==\",\n         \"public\": \"MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC+W6scd3XWwvC/hPRksfDYFi3ztgyS9OSqnnjtNQeDdTSD1DRx/xFar2wjmzxp2+SnJ5pspaF77VZveN3P/HVmXZVghr3asoV9WBx/uW1nDIUxU35L4juXiTwsMAbgMyh3NqIKTNKyMDy4P8vpEhtH1iv/BrwMdBjHDVCycB8WnwIDAQAB\",\n         \"selector\": \"hello_selector\"\n     },\n     \"is_default_bounce_domain\": 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              \"message\": \"invalid params\",\n              \"description\": \"Tracking domain '(domain)' is not a registered tracking domain\",\n              \"code\": \"1200\"\n          }\n      ]\n  }\n\n  {\n      \"errors\": [\n          {\n              \"message\": \"request to remote endpoint failed\",\n              \"description\": \"Unable to verify DKIM record of example1.com. DNS DKIM query error: 'v=DKIM1;' is missing a p= tag\",\n              \"code\": \"1404\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Delete a Sending Domain"}},"attributes":{"href":{"element":"string","content":"/v1/sending-domains/{domain}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Delete a Sending Domain"}},"attributes":{"href":{"element":"string","content":"/v1/sending-domains/{domain}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"domain"},"value":{"element":"string","content":"example1.com"}}}]}},"content":[{"element":"copy","content":"<Banner status=\"danger\"><strong>Warning</strong>: Before deleting a sending domain please ensure you are no longer using it. After deleting a sending domain, any new transmissions that use it will result in a rejection. This includes any transmissions that are in progress, scheduled for the future, or use a stored template referencing the sending domain.</Banner>"},{"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":"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              \"code\": \"1600\",\n              \"message\": \"resource not found\",\n              \"description\": \"Domain 'wrong.domain' does not exist\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"List all Sending Domains"}},"attributes":{"href":{"element":"string","content":"/v1/sending-domains{?ownership_verified,dkim_status,cname_status,mx_status,abuse_at_status,postmaster_at_status,compliance_status,is_default_bounce_domain}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"List all Sending Domains"}},"attributes":{"href":{"element":"string","content":"/v1/sending-domains{?ownership_verified,dkim_status,cname_status,mx_status,abuse_at_status,postmaster_at_status,compliance_status,is_default_bounce_domain}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"description":{"element":"string","content":"Ownership verified filter. Valid values are `true` or `false`."},"title":{"element":"string","content":"boolean"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"ownership_verified"},"value":{"element":"string","content":"true"}}},{"element":"member","meta":{"description":{"element":"string","content":"DKIM status filter."},"title":{"element":"string","content":"enum"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"dkim_status"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"string","content":"valid"},{"element":"string","content":"invalid"},{"element":"string","content":"unverified"},{"element":"string","content":"pending"}]}}}}},{"element":"member","meta":{"description":{"element":"string","content":"CNAME status filter."},"title":{"element":"string","content":"enum"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"cname_status"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"string","content":"valid"},{"element":"string","content":"invalid"},{"element":"string","content":"unverified"},{"element":"string","content":"pending"}]}}}}},{"element":"member","meta":{"description":{"element":"string","content":"MX status filter."},"title":{"element":"string","content":"enum"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"mx_status"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"string","content":"valid"},{"element":"string","content":"invalid"},{"element":"string","content":"unverified"},{"element":"string","content":"pending"}]}}}}},{"element":"member","meta":{"description":{"element":"string","content":"abuse@ status filter."},"title":{"element":"string","content":"enum"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"abuse_at_status"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"string","content":"valid"},{"element":"string","content":"invalid"},{"element":"string","content":"unverified"},{"element":"string","content":"pending"}]}}}}},{"element":"member","meta":{"description":{"element":"string","content":"postmaster@ status filter."},"title":{"element":"string","content":"enum"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"postmaster_at_status"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"string","content":"valid"},{"element":"string","content":"invalid"},{"element":"string","content":"unverified"},{"element":"string","content":"pending"}]}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Compliance status filter."},"title":{"element":"string","content":"enum"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"compliance_status"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"string","content":"valid"},{"element":"string","content":"blocked"}]}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Is default bounce domain filter. Valid values are `true` or `false`."},"title":{"element":"string","content":"boolean"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"is_default_bounce_domain"},"value":{"element":"string"}}}]}},"content":[{"element":"copy","content":"Returns an array with all the sending domains in your account. Use the query parameters to filter on the various status options."},{"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              \"domain\": \"example1.com\",\n              \"tracking_domain\": \"click.example1.com\",\n              \"status\": {\n                  \"ownership_verified\": true,\n                  \"spf_status\": \"unverified\",\n                  \"abuse_at_status\": \"unverified\",\n                  \"dkim_status\": \"valid\",\n                  \"cname_status\": \"valid\",\n                  \"mx_status\": \"unverified\",\n                  \"compliance_status\": \"valid\",\n                  \"postmaster_at_status\": \"unverified\",\n                  \"verification_mailbox_status\": \"valid\",\n                  \"verification_mailbox\": \"susan.calvin\"\n              },\n              \"shared_with_subaccounts\": false,\n              \"is_default_bounce_domain\" : false\n          },\n          {\n              \"domain\": \"example2.com\",\n              \"status\": {\n                  \"ownership_verified\": true,\n                  \"spf_status\": \"unverified\",\n                  \"abuse_at_status\": \"unverified\",\n                  \"dkim_status\": \"valid\",\n                  \"cname_status\": \"valid\",\n                  \"mx_status\": \"unverified\",\n                  \"compliance_status\": \"valid\",\n                  \"postmaster_at_status\": \"unverified\",\n                  \"verification_mailbox_status\": \"unverified\"\n              },\n              \"shared_with_subaccounts\": false,\n              \"is_default_bounce_domain\" : false\n          }\n      ]\n  }\nThese endpoints manage additional DKIM keys for sending domains. Each sending domain can have up to 256 additional DKIM keys. The \"default\" key is managed via the standard [Sending Domain](#header-sending-domain-object) endpoints above.\n\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"List DKIM Keys"}},"attributes":{"href":{"element":"string","content":"/v1/sending-domains/{domain}/dkim-keys"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"List DKIM Keys"}},"attributes":{"href":{"element":"string","content":"/v1/sending-domains/{domain}/dkim-keys"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"domain"},"value":{"element":"string","content":"example.com"}}}]}},"content":[{"element":"copy","content":"Retrieves all DKIM keys for a domain, including the default key.\n\nThe default key is always first in the list and does not have `created_at` or `updated_at` fields. The `dns` object is not included in list responses."},{"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              \"id\": \"default\",\n              \"signing_domain\": \"example.com\",\n              \"public\": \"MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQ...\",\n              \"selector\": \"scph0820\",\n              \"headers\": \"from:to:subject:date\",\n              \"dkim_status\": \"valid\",\n              \"is_default\": true,\n              \"dkim_key_length\": 2048\n          },\n          {\n              \"id\": \"marketing\",\n              \"signing_domain\": \"mkt.example.com\",\n              \"public\": \"MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQ...\",\n              \"selector\": \"mkt0125\",\n              \"headers\": \"from:to:subject:date\",\n              \"dkim_status\": \"valid\",\n              \"is_default\": false,\n              \"dkim_key_length\": 2048,\n              \"created_at\": \"2025-01-25T14:00:00Z\",\n              \"updated_at\": \"2025-01-25T14:00:00Z\"\n          }\n      ],\n      \"total_count\": 2\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              \"code\": \"1600\",\n              \"message\": \"resource not found\",\n              \"description\": \"Domain 'example.com' does not exist\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Create a DKIM Key"}},"attributes":{"href":{"element":"string","content":"/v1/sending-domains/{domain}/dkim-keys"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Create a DKIM Key"}},"attributes":{"href":{"element":"string","content":"/v1/sending-domains/{domain}/dkim-keys"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"domain"},"value":{"element":"string","content":"example.com"}}}]}},"content":[{"element":"copy","content":"Creates a new DKIM key. The system generates the keypair automatically unless you provide your own.\n\nWhen providing your own keys, all three fields (`private`, `public`, `selector`) must be provided together.\n\n-   Data Structure\n\n    -   id (string, required) - Unique identifier. 1-64 characters, alphanumeric plus hyphen/underscore, must start with alphanumeric.\n    -   signing_domain (string) - Domain for DKIM signature. Defaults to the sending domain.\n    -   headers (string) - Colon-separated headers to sign.\n        -   Default: from:to:subject:date\n    -   private (string) - User-provided private key. Requires `public` and `selector`.\n    -   public (string) - User-provided public key. Requires `private` and `selector`.\n    -   selector (string) - User-provided selector. Requires `private` and `public`.\n    -   dkim_key_length (number) - Key length, in bits, for auto-generation. Must be between 1024 and 4096. New keys default to 2048; pass `1024` only if your DNS provider does not support multi-string TXT records.\n        -   Default: 2048"},{"element":"httpTransaction","content":[{"element":"httpRequest","meta":{"title":{"element":"string","content":"Auto-generate keys"}},"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      \"id\": \"marketing\",\n      \"signing_domain\": \"mkt.example.com\",\n      \"headers\": \"from:to:subject:date\"\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          \"id\": \"marketing\",\n          \"signing_domain\": \"mkt.example.com\",\n          \"public\": \"MFwwDQYJKoZIhvcNAQEB...\",\n          \"selector\": \"mkt0125\",\n          \"headers\": \"from:to:subject:date\",\n          \"dkim_status\": \"unverified\",\n          \"is_default\": false,\n          \"dkim_key_length\": 2048,\n          \"created_at\": \"2025-01-25T14:00:00Z\",\n          \"updated_at\": \"2025-01-25T14:00:00Z\",\n          \"dns\": {\n              \"dkim_record\": \"mkt0125._domainkey.mkt.example.com\",\n              \"dkim_value\": \"v=DKIM1; k=rsa; h=sha256; p=MFwwDQYJKoZIhvcNAQEB...\"\n          }\n      }\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","meta":{"title":{"element":"string","content":"User-provided keys"}},"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      \"id\": \"marketing\",\n      \"private\": \"MIICXQIBAAJBALxYLMK...\",\n      \"public\": \"MFwwDQYJKoZIhvcNAQEB...\",\n      \"selector\": \"mkt2025\"\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          \"id\": \"marketing\",\n          \"signing_domain\": \"example.com\",\n          \"public\": \"MFwwDQYJKoZIhvcNAQEB...\",\n          \"selector\": \"mkt2025\",\n          \"headers\": \"from:to:subject:date\",\n          \"dkim_status\": \"unverified\",\n          \"is_default\": false,\n          \"dkim_key_length\": 2048,\n          \"created_at\": \"2025-01-25T14:00:00Z\",\n          \"updated_at\": \"2025-01-25T14:00:00Z\",\n          \"dns\": {\n              \"dkim_record\": \"mkt2025._domainkey.example.com\",\n              \"dkim_value\": \"v=DKIM1; k=rsa; h=sha256; p=MFwwDQYJKoZIhvcNAQEB...\"\n          }\n      }\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","meta":{"title":{"element":"string","content":"User-provided keys"}},"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      \"id\": \"marketing\",\n      \"private\": \"MIICXQIBAAJBALxYLMK...\",\n      \"public\": \"MFwwDQYJKoZIhvcNAQEB...\",\n      \"selector\": \"mkt2025\"\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              \"code\": \"1300\",\n              \"message\": \"invalid params\",\n              \"description\": \"Key ID 'marketing' already exists\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","meta":{"title":{"element":"string","content":"User-provided keys"}},"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      \"id\": \"marketing\",\n      \"private\": \"MIICXQIBAAJBALxYLMK...\",\n      \"public\": \"MFwwDQYJKoZIhvcNAQEB...\",\n      \"selector\": \"mkt2025\"\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              \"code\": \"1300\",\n              \"message\": \"invalid params\",\n              \"description\": \"Key ID 'default' is reserved\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","meta":{"title":{"element":"string","content":"User-provided keys"}},"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      \"id\": \"marketing\",\n      \"private\": \"MIICXQIBAAJBALxYLMK...\",\n      \"public\": \"MFwwDQYJKoZIhvcNAQEB...\",\n      \"selector\": \"mkt2025\"\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              \"code\": \"1300\",\n              \"message\": \"invalid params\",\n              \"description\": \"When providing custom keys, private, public, and selector must all be specified\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","meta":{"title":{"element":"string","content":"User-provided keys"}},"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      \"id\": \"marketing\",\n      \"private\": \"MIICXQIBAAJBALxYLMK...\",\n      \"public\": \"MFwwDQYJKoZIhvcNAQEB...\",\n      \"selector\": \"mkt2025\"\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              \"code\": \"1600\",\n              \"message\": \"resource not found\",\n              \"description\": \"Domain 'example.com' does not exist\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","meta":{"title":{"element":"string","content":"User-provided keys"}},"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      \"id\": \"marketing\",\n      \"private\": \"MIICXQIBAAJBALxYLMK...\",\n      \"public\": \"MFwwDQYJKoZIhvcNAQEB...\",\n      \"selector\": \"mkt2025\"\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              \"code\": \"1400\",\n              \"message\": \"required field is missing\",\n              \"description\": \"id is required\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Retrieve a DKIM Key"}},"attributes":{"href":{"element":"string","content":"/v1/sending-domains/{domain}/dkim-keys/{key_id}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Retrieve a DKIM Key"}},"attributes":{"href":{"element":"string","content":"/v1/sending-domains/{domain}/dkim-keys/{key_id}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"domain"},"value":{"element":"string","content":"example.com"}}},{"element":"member","meta":{"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"key_id"},"value":{"element":"string","content":"marketing"}}}]}},"content":[{"element":"copy","content":"Retrieves a specific DKIM key by ID.\n\nUsing `key_id` of \"default\" returns the domain's primary DKIM key. The default key has `is_default: true` and no `created_at`/`updated_at` fields."},{"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          \"id\": \"marketing\",\n          \"signing_domain\": \"mkt.example.com\",\n          \"public\": \"MFwwDQYJKoZIhvcNAQEB...\",\n          \"selector\": \"mkt0125\",\n          \"headers\": \"from:to:subject:date\",\n          \"dkim_status\": \"valid\",\n          \"is_default\": false,\n          \"dkim_key_length\": 2048,\n          \"created_at\": \"2025-01-25T14:00:00Z\",\n          \"updated_at\": \"2025-01-25T14:00:00Z\",\n          \"dns\": {\n              \"dkim_record\": \"mkt0125._domainkey.mkt.example.com\",\n              \"dkim_value\": \"v=DKIM1; k=rsa; h=sha256; p=MFwwDQYJKoZIhvcNAQEB...\"\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              \"code\": \"1600\",\n              \"message\": \"resource not found\",\n              \"description\": \"DKIM key 'marketing' does not exist\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Update a DKIM Key"}},"attributes":{"href":{"element":"string","content":"/v1/sending-domains/{domain}/dkim-keys/{key_id}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Update a DKIM Key"}},"attributes":{"href":{"element":"string","content":"/v1/sending-domains/{domain}/dkim-keys/{key_id}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"domain"},"value":{"element":"string","content":"example.com"}}},{"element":"member","meta":{"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"key_id"},"value":{"element":"string","content":"marketing"}}}]}},"content":[{"element":"copy","content":"Updates an existing DKIM key. Only `headers` and `signing_domain` can be updated individually. To replace keys, all three (`private`, `public`, `selector`) must be provided together.\n\nThe default key cannot be updated via this endpoint. Use the [Update a Sending Domain](#sending-domains-put-update-a-sending-domain) endpoint instead.\n\nChanging `signing_domain` or key fields resets `dkim_status` to `unverified`.\n\n-   Data Structure\n\n    -   signing_domain (string) - New signing domain.\n    -   headers (string) - New headers to sign.\n    -   private (string) - New private key. Requires `public` and `selector`.\n    -   public (string) - New public key. Requires `private` and `selector`.\n    -   selector (string) - New selector. Requires `private` and `public`."},{"element":"httpTransaction","content":[{"element":"httpRequest","meta":{"title":{"element":"string","content":"Update headers"}},"attributes":{"method":{"element":"string","content":"PUT"},"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      \"headers\": \"from:to:subject:date:reply-to\"\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          \"message\": \"Successfully updated DKIM key.\",\n          \"id\": \"marketing\",\n          \"signing_domain\": \"mkt.example.com\",\n          \"public\": \"MFwwDQYJKoZIhvcNAQEB...\",\n          \"selector\": \"mkt0125\",\n          \"headers\": \"from:to:subject:date:reply-to\",\n          \"dkim_status\": \"valid\",\n          \"is_default\": false,\n          \"dkim_key_length\": 2048,\n          \"created_at\": \"2025-01-25T14:00:00Z\",\n          \"updated_at\": \"2025-01-25T16:30:00Z\",\n          \"dns\": {\n              \"dkim_record\": \"mkt0125._domainkey.mkt.example.com\",\n              \"dkim_value\": \"v=DKIM1; k=rsa; h=sha256; p=MFwwDQYJKoZIhvcNAQEB...\"\n          }\n      }\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","meta":{"title":{"element":"string","content":"Full key replacement"}},"attributes":{"method":{"element":"string","content":"PUT"},"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      \"private\": \"MIICXQIBAAJBALxYLMK...\",\n      \"public\": \"MFwwDQYJKoZIhvcNAQEB...\",\n      \"selector\": \"newsel2025\"\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          \"message\": \"Successfully updated DKIM key.\",\n          \"id\": \"marketing\",\n          \"signing_domain\": \"mkt.example.com\",\n          \"public\": \"MFwwDQYJKoZIhvcNAQEB...\",\n          \"selector\": \"newsel2025\",\n          \"headers\": \"from:to:subject:date\",\n          \"dkim_status\": \"unverified\",\n          \"is_default\": false,\n          \"dkim_key_length\": 2048,\n          \"created_at\": \"2025-01-25T14:00:00Z\",\n          \"updated_at\": \"2025-01-25T16:30:00Z\",\n          \"dns\": {\n              \"dkim_record\": \"newsel2025._domainkey.mkt.example.com\",\n              \"dkim_value\": \"v=DKIM1; k=rsa; h=sha256; p=MFwwDQYJKoZIhvcNAQEB...\"\n          }\n      }\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","meta":{"title":{"element":"string","content":"Full key replacement"}},"attributes":{"method":{"element":"string","content":"PUT"},"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      \"private\": \"MIICXQIBAAJBALxYLMK...\",\n      \"public\": \"MFwwDQYJKoZIhvcNAQEB...\",\n      \"selector\": \"newsel2025\"\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              \"code\": \"1300\",\n              \"message\": \"invalid params\",\n              \"description\": \"Cannot update default key via this endpoint. Use /sending-domains/{domain} instead.\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","meta":{"title":{"element":"string","content":"Full key replacement"}},"attributes":{"method":{"element":"string","content":"PUT"},"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      \"private\": \"MIICXQIBAAJBALxYLMK...\",\n      \"public\": \"MFwwDQYJKoZIhvcNAQEB...\",\n      \"selector\": \"newsel2025\"\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              \"code\": \"1300\",\n              \"message\": \"invalid params\",\n              \"description\": \"Field 'id' is immutable\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","meta":{"title":{"element":"string","content":"Full key replacement"}},"attributes":{"method":{"element":"string","content":"PUT"},"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      \"private\": \"MIICXQIBAAJBALxYLMK...\",\n      \"public\": \"MFwwDQYJKoZIhvcNAQEB...\",\n      \"selector\": \"newsel2025\"\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              \"code\": \"1300\",\n              \"message\": \"invalid params\",\n              \"description\": \"When providing custom keys, private, public, and selector must all be specified\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","meta":{"title":{"element":"string","content":"Full key replacement"}},"attributes":{"method":{"element":"string","content":"PUT"},"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      \"private\": \"MIICXQIBAAJBALxYLMK...\",\n      \"public\": \"MFwwDQYJKoZIhvcNAQEB...\",\n      \"selector\": \"newsel2025\"\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              \"code\": \"1600\",\n              \"message\": \"resource not found\",\n              \"description\": \"DKIM key 'marketing' does not exist\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Delete a DKIM Key"}},"attributes":{"href":{"element":"string","content":"/v1/sending-domains/{domain}/dkim-keys/{key_id}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Delete a DKIM Key"}},"attributes":{"href":{"element":"string","content":"/v1/sending-domains/{domain}/dkim-keys/{key_id}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"domain"},"value":{"element":"string","content":"example.com"}}},{"element":"member","meta":{"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"key_id"},"value":{"element":"string","content":"marketing"}}}]}},"content":[{"element":"copy","content":"Deletes a DKIM key. The default key cannot be deleted."},{"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              \"code\": \"1300\",\n              \"message\": \"invalid params\",\n              \"description\": \"Cannot delete default key\"\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              \"code\": \"1600\",\n              \"message\": \"resource not found\",\n              \"description\": \"DKIM key 'marketing' does not exist\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Verify a DKIM Key"}},"attributes":{"href":{"element":"string","content":"/v1/sending-domains/{domain}/dkim-keys/{key_id}/verify"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Verify a DKIM Key"}},"attributes":{"href":{"element":"string","content":"/v1/sending-domains/{domain}/dkim-keys/{key_id}/verify"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"domain"},"value":{"element":"string","content":"example.com"}}},{"element":"member","meta":{"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"key_id"},"value":{"element":"string","content":"marketing"}}}]}},"content":[{"element":"copy","content":"Initiates DNS verification for a specific DKIM key.\n\nThe default key cannot be verified via this endpoint. Use the [Verify a Sending Domain](#sending-domains-post-verify-a-sending-domain) endpoint with `dkim_verify: true` instead."},{"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"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {}\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          \"id\": \"marketing\",\n          \"dkim_status\": \"valid\",\n          \"dns\": {\n              \"dkim_record\": \"mkt0125._domainkey.mkt.example.com\",\n              \"dkim_value\": \"v=DKIM1; k=rsa; h=sha256; p=MFwwDQYJKoZIhvcNAQEB...\"\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"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {}\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          \"id\": \"marketing\",\n          \"dkim_status\": \"invalid\",\n          \"dns\": {\n              \"dkim_record\": \"mkt0125._domainkey.mkt.example.com\",\n              \"dkim_value\": \"v=DKIM1; k=rsa; h=sha256; p=MFwwDQYJKoZIhvcNAQEB...\",\n              \"dkim_error\": \"DNS record not found. Please add the TXT record and try again.\"\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"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {}\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              \"code\": \"1300\",\n              \"message\": \"invalid params\",\n              \"description\": \"Cannot verify default key via this endpoint. Use /sending-domains/{domain}/verify with dkim_verify: true instead.\"\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"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {}\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              \"code\": \"1600\",\n              \"message\": \"resource not found\",\n              \"description\": \"DKIM key 'marketing' does not exist\"\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":"7e0f1bb25eb7f82ba15e8594bfee0363"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"The domain you are sending from. It will be used in the \"From:\" header address in emails."}},"content":{"key":{"element":"string","content":"domain"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Associated tracking domain."}},"content":{"key":{"element":"string","content":"tracking_domain"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Object containing status details, including whether this domain's ownership has been verified."}},"content":{"key":{"element":"string","content":"status"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"  Whether domain ownership has been verified. This field will return `true` if any of the following status fields are valid."}},"content":{"key":{"element":"string","content":"ownership_verified"},"value":{"element":"boolean","attributes":{"default":{"element":"boolean","content":false}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Verification status of DKIM configuration."}},"content":{"key":{"element":"string","content":"dkim_status"},"value":{"element":"enum","attributes":{"default":{"element":"enum","content":{"element":"string","content":"unverified"}},"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":"Verification status of CNAME configuration."}},"content":{"key":{"element":"string","content":"cname_status"},"value":{"element":"enum","attributes":{"default":{"element":"enum","content":{"element":"string","content":"unverified"}},"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":"Verification status of MX configuration. <br />Only available for <span class=\"label label-warning\"><strong>Enterprise</strong></span> accounts."}},"content":{"key":{"element":"string","content":"mx_status"},"value":{"element":"enum","attributes":{"default":{"element":"enum","content":{"element":"string","content":"unverified"}},"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":"<span class=\"label label-danger\"><strong>Deprecated</strong></span> Verification status of SPF configuration."}},"content":{"key":{"element":"string","content":"spf_status"},"value":{"element":"enum","attributes":{"default":{"element":"enum","content":{"element":"string","content":"unverified"}},"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":"Verification status of abuse@ mailbox."}},"content":{"key":{"element":"string","content":"abuse_at_status"},"value":{"element":"enum","attributes":{"default":{"element":"enum","content":{"element":"string","content":"unverified"}},"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":"Verification status of postmaster@ mailbox."}},"content":{"key":{"element":"string","content":"postmaster_at_status"},"value":{"element":"enum","attributes":{"default":{"element":"enum","content":{"element":"string","content":"unverified"}},"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":"Verification status of nominated anyone@ mailbox."}},"content":{"key":{"element":"string","content":"verification_mailbox_status"},"value":{"element":"enum","attributes":{"default":{"element":"enum","content":{"element":"string","content":"unverified"}},"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":"Nominated anyone@ verification mailbox email address local part. This field will only be returned if it was set in the `verification_mailbox` attribute in a [verification request](#sending-domains-post-verify-a-sending-domain)."}},"content":{"key":{"element":"string","content":"verification_mailbox"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Compliance status"}},"content":{"key":{"element":"string","content":"compliance_status"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"string","content":"valid"},{"element":"string","content":"blocked"}]}}}}}]}}},{"element":"member","meta":{"description":{"element":"string","content":"Object in which DKIM key configuration is defined."}},"content":{"key":{"element":"string","content":"dkim"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"  Value used as the Signing Domain Identifier (SDID). This will be used in the `d=` field of the DKIM Signature. <br /> Only writable by <span class=\"label label-warning\"><strong>Enterprise</strong></span> accounts."}},"content":{"key":{"element":"string","content":"signing_domain"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Value used as the public key which will be retrieved from the DNS of the sending domain."}},"content":{"key":{"element":"string","content":"public"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Value used as the DomainKey selector which indicates the DKIM public key location."}},"content":{"key":{"element":"string","content":"selector"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Header fields to be included in the DKIM signature. **This field is currently ignored.**"}},"content":{"key":{"element":"string","content":"headers"},"value":{"element":"string"}}}]}}},{"element":"member","meta":{"description":{"element":"string","content":"Whether this domain can be used by subaccounts. Only available to domains belonging to a primary account."}},"content":{"key":{"element":"string","content":"shared_with_subaccounts"},"value":{"element":"boolean"}}},{"element":"member","meta":{"description":{"element":"string","content":"The subaccount ID that the sending domain belongs to. Only available to domains belonging to a subaccount."}},"content":{"key":{"element":"string","content":"subaccount_id"},"value":{"element":"number"}}},{"element":"member","meta":{"description":{"element":"string","content":"  Whether this domain should be used as the bounce domain when no other valid bounce domain has been specified in the transmission or SMTP injection. Only available to domains with cname_status of \"valid\" or mx_status of \"valid\".  The primary account as well as each subaccount may set a unique default bounce domain. <br /> Not available for <span class=\"label label-warning\"><strong>Enterprise</strong></span> accounts."}},"content":{"key":{"element":"string","content":"is_default_bounce_domain"},"value":{"element":"boolean"}}},{"element":"member","meta":{"description":{"element":"string","content":"Datetime the domain was created. <br />Format: YYYY-MM-DDTHH:MM:SS+-HH:MM"}},"content":{"key":{"element":"string","content":"creation_time"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Whether this domain was delegated to SparkPost by the customer. Will not be present if false. <br /> Only available for <span class=\"label label-warning\"><strong>Enterprise</strong></span> accounts."}},"content":{"key":{"element":"string","content":"delegated"},"value":{"element":"boolean"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"5761b8f246fbc78097f6d2038d7f67fc"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"The domain you are sending from."}},"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":"Associated tracking domain. The tracking domain and sending domain must belong to the same subaccount."}},"content":{"key":{"element":"string","content":"tracking_domain"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Object in which DKIM key configuration is defined. Will be generated if `generate_dkim` is true."}},"content":{"key":{"element":"string","content":"dkim"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"Value used as the Signing Domain Identifier (SDID)."}},"content":{"key":{"element":"string","content":"signing_domain"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Valued used as the private key which will be used to create the DKIM Signature."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"private"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Value used as the public key which will be retrieved from the DNS of the sending domain."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"public"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Value used as the DomainKey selector which indicates the DKIM public key location."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"selector"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Header fields to be included in the DKIM signature. **This field is currently ignored.**"}},"content":{"key":{"element":"string","content":"headers"},"value":{"element":"string"}}}]}}},{"element":"member","meta":{"description":{"element":"string","content":"Whether to generate a DKIM keypair on creation."}},"content":{"key":{"element":"string","content":"generate_dkim"},"value":{"element":"boolean","attributes":{"default":{"element":"boolean","content":true}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Size, in bits, of the DKIM private key to be generated. This option only applies if `generate_dkim` is true. New sending domains default to a 2048-bit key; pass `1024` here if your DNS provider does not support multi-string TXT records. <br /><span class=\"label label-info\"><strong>Note</strong></span> public keys for private keys longer than 1024 bits (including the new 2048-bit default, which yields TXT values around 400 characters) exceed the single-string TXT record limit of 255 characters. The public key <code>TXT</code> record in DNS must therefore contain multiple quoted strings; see <a href=\"https://tools.ietf.org/html/rfc7208#section-3.3\">RFC 7208, section 3.3</a> for an example of how the SPF spec addresses the same constraint. Most modern DNS providers (Route 53, Cloudflare, Google Cloud DNS, Azure DNS) split long TXT records automatically."}},"content":{"key":{"element":"string","content":"dkim_key_length"},"value":{"element":"number","attributes":{"default":{"element":"number","content":2048}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Whether this domain can be used by subaccounts. Only available to domains belonging to a primary account."}},"content":{"key":{"element":"string","content":"shared_with_subaccounts"},"value":{"element":"boolean","attributes":{"default":{"element":"boolean","content":false}}}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"25f81792bd1889c67abdf53580cf9ffc"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Request verification of DKIM record."}},"content":{"key":{"element":"string","content":"dkim_verify"},"value":{"element":"boolean"}}},{"element":"member","meta":{"description":{"element":"string","content":"Request verification of CNAME record."}},"content":{"key":{"element":"string","content":"cname_verify"},"value":{"element":"boolean"}}},{"element":"member","meta":{"description":{"element":"string","content":"Request an email with a verification link to be sent to a mailbox on the sending domain. The mailbox is set in the `verification_mailbox` field.  The mailbox can be any valid mailbox for the domain other than \"postmaster\" or \"abuse\". <br /> Not available in <span class=\"label label-warning\"><strong>Enterprise</strong></span>"}},"content":{"key":{"element":"string","content":"verification_mailbox_verify"},"value":{"element":"boolean"}}},{"element":"member","meta":{"description":{"element":"string","content":"The nominated mailbox email address local part to be used when requesting email with a verification link be sent. Required if `verification_mailbox_verify` is true. <br /> Not available in <span class=\"label label-warning\"><strong>Enterprise</strong></span>"}},"content":{"key":{"element":"string","content":"verification_mailbox"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Request an email with a verification link to be sent to the sending domain's postmaster@ mailbox."}},"content":{"key":{"element":"string","content":"postmaster_at_verify"},"value":{"element":"boolean"}}},{"element":"member","meta":{"description":{"element":"string","content":"Request an email with a verification link to be sent to the sending domain's abuse@ mailbox."}},"content":{"key":{"element":"string","content":"abuse_at_verify"},"value":{"element":"boolean"}}},{"element":"member","meta":{"description":{"element":"string","content":"A token retrieved from the verification link contained in the verification email.<br /> Not available in <span class=\"label label-warning\"><strong>Enterprise</strong></span>"}},"content":{"key":{"element":"string","content":"verification_mailbox_token"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"A token retrieved from the verification link contained in the postmaster@ verification email."}},"content":{"key":{"element":"string","content":"postmaster_at_token"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"A token retrieved from the verification link contained in the abuse@ verification email."}},"content":{"key":{"element":"string","content":"abuse_at_token"},"value":{"element":"string"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"cfacff45ac544d6e43cfb9765b5afac2"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"DNS DKIM record for the registered sending domain"}},"content":{"key":{"element":"string","content":"dkim_record"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"DNS CNAME record for the registered sending domain"}},"content":{"key":{"element":"string","content":"cname_record"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Error message describing reason for DKIM verification failure"}},"content":{"key":{"element":"string","content":"dkim_error"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Error message describing reason for CNAME verification failure"}},"content":{"key":{"element":"string","content":"cname_error"},"value":{"element":"string"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"ead910e77c7765cef31a1036c8ec8e05"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Associated tracking domain. To remove the current value, set it to an empty string. The tracking domain and sending domain must belong to the same subaccount."}},"content":{"key":{"element":"string","content":"tracking_domain"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"DKIM configuration. Will be verified prior to update. If verification fails, the update will fail."}},"content":{"key":{"element":"string","content":"dkim"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"Value used as the Signing Domain Identifier (SDID). To remove the current value, set it to an empty string."}},"content":{"key":{"element":"string","content":"signing_domain"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Valued used as the private key which will be used to create the DKIM Signature."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"private"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Value used as the public key which will be retrieved from the DNS of the sending domain."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"public"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Value used as the DomainKey selector which indicates the DKIM public key location."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"selector"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Header fields to be included in the DKIM signature. **This field is currently ignored.**"}},"content":{"key":{"element":"string","content":"headers"},"value":{"element":"string"}}}]}}},{"element":"member","meta":{"description":{"element":"string","content":"Whether this domain can be used by subaccounts. Only available to domains belonging to a primary account."}},"content":{"key":{"element":"string","content":"shared_with_subaccounts"},"value":{"element":"boolean"}}},{"element":"member","meta":{"description":{"element":"string","content":"Whether this domain should be used as the bounce domain when no other valid bounce domain has been specified in the transmission or SMTP injection. Only available to domains with `cname_status` or `mx_status` equal to valid. The primary account and each subaccount may set it's own unique default bounce domain.<br /> Not available for <span class=\"label label-warning\"><strong>Enterprise</strong></span> accounts."}},"content":{"key":{"element":"string","content":"is_default_bounce_domain"},"value":{"element":"boolean"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"083206b7aeb0a886c966ef5a2b622b12"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Unique identifier for the DKIM key. 1-64 characters, alphanumeric plus hyphen/underscore, must start with alphanumeric."}},"content":{"key":{"element":"string","content":"id"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Domain used for the DKIM signature."}},"content":{"key":{"element":"string","content":"signing_domain"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Base64-encoded public key."}},"content":{"key":{"element":"string","content":"public"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"DKIM selector indicating the public key location."}},"content":{"key":{"element":"string","content":"selector"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Colon-separated list of headers to sign."}},"content":{"key":{"element":"string","content":"headers"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Verification status of the DKIM key."}},"content":{"key":{"element":"string","content":"dkim_status"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"string","content":"unverified"},{"element":"string","content":"pending"},{"element":"string","content":"valid"},{"element":"string","content":"invalid"}]}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Whether this is the default key for the domain."}},"content":{"key":{"element":"string","content":"is_default"},"value":{"element":"boolean"}}},{"element":"member","meta":{"description":{"element":"string","content":"Size, in bits, of the RSA modulus of the stored DKIM key (e.g. `2048`). Derived from the public key on each read, so it always reflects the actual key currently in use for the domain."}},"content":{"key":{"element":"string","content":"dkim_key_length"},"value":{"element":"number"}}},{"element":"member","meta":{"description":{"element":"string","content":"ISO 8601 timestamp of creation. Not present for default keys."}},"content":{"key":{"element":"string","content":"created_at"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"ISO 8601 timestamp of last update. Not present for default keys."}},"content":{"key":{"element":"string","content":"updated_at"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"DNS record information. Included in single key GET, POST create, POST verify, and PUT update responses."}},"content":{"key":{"element":"string","content":"dns"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"Full DNS record name."}},"content":{"key":{"element":"string","content":"dkim_record"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Expected TXT record value."}},"content":{"key":{"element":"string","content":"dkim_value"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Error message if verification failed. Only present in verify responses."}},"content":{"key":{"element":"string","content":"dkim_error"},"value":{"element":"string"}}}]}}}]}}]}]},{"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":13110},{"element":"number","content":64}]}]}]}},"content":"the resource '/v1/sending-domains/{domain}' is already defined"},{"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":15597},{"element":"number","content":67}]}]}]}},"content":"the resource '/v1/sending-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":20054},{"element":"number","content":14}]}]}]}},"content":"unexpected header block, expected a group, resource or an action definition, e.g. '# Group <name>', '# <resource name> [<URI>]' or '# <HTTP method> <URI>'"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":10},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":20068},{"element":"number","content":238}]}]}]}},"content":"dangling message-body asset, expected a pre-formatted code block, indent every of it's line by 8 spaces or 2 tabs"},{"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":20306},{"element":"number","content":21}]}]}]}},"content":"unexpected header block, expected a group, resource or an action definition, e.g. '# Group <name>', '# <resource name> [<URI>]' or '# <HTTP method> <URI>'"},{"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":20327},{"element":"number","content":691}]}]}]}},"content":"ignoring unrecognized block"},{"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":21018},{"element":"number","content":27}]}]}]}},"content":"unexpected header block, expected a group, resource or an action definition, e.g. '# Group <name>', '# <resource name> [<URI>]' or '# <HTTP method> <URI>'"},{"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":21045},{"element":"number","content":838}]}]}]}},"content":"ignoring unrecognized block"},{"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":21883},{"element":"number","content":36}]}]}]}},"content":"unexpected header block, expected a group, resource or an action definition, e.g. '# Group <name>', '# <resource name> [<URI>]' or '# <HTTP method> <URI>'"},{"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":21919},{"element":"number","content":189}]}]}]}},"content":"ignoring unrecognized block"},{"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":22108},{"element":"number","content":24}]}]}]}},"content":"ignoring unrecognized block"},{"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":22132},{"element":"number","content":306}]}]}]}},"content":"ignoring unrecognized block"},{"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":22438},{"element":"number","content":32}]}]}]}},"content":"ignoring unrecognized block"},{"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":22470},{"element":"number","content":65}]}]}]}},"content":"ignoring unrecognized block"},{"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":22535},{"element":"number","content":59}]}]}]}},"content":"ignoring unrecognized block"},{"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":22594},{"element":"number","content":54}]}]}]}},"content":"ignoring unrecognized block"},{"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":22648},{"element":"number","content":59}]}]}]}},"content":"ignoring unrecognized block"},{"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":22707},{"element":"number","content":39}]}]}]}},"content":"ignoring unrecognized block"},{"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":22746},{"element":"number","content":280}]}]}]}},"content":"ignoring unrecognized block"},{"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":23026},{"element":"number","content":27}]}]}]}},"content":"unexpected header block, expected a group, resource or an action definition, e.g. '# Group <name>', '# <resource name> [<URI>]' or '# <HTTP method> <URI>'"},{"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":23053},{"element":"number","content":2395}]}]}]}},"content":"ignoring unrecognized block"},{"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":27305},{"element":"number","content":69}]}]}]}},"content":"the resource '/v1/sending-domains/{domain}/dkim-keys' is already defined"},{"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":33760},{"element":"number","content":77}]}]}]}},"content":"the resource '/v1/sending-domains/{domain}/dkim-keys/{key_id}' is already defined"},{"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":38208},{"element":"number","content":80}]}]}]}},"content":"the resource '/v1/sending-domains/{domain}/dkim-keys/{key_id}' is already defined"}]},"TableOfContents":[{"anchor":"#sending-domains","title":"Sending Domains","children":[{"anchor":"#header-dns-notes","title":"DNS notes"},{"anchor":"#header-using-a-sending-domain-as-a-bounce-domain","title":"Using a sending domain as a bounce domain"},{"anchor":"#header-sending-domain-object","title":"Sending Domain Object"},{"anchor":"#sending-domains-create-a-sending-domain","title":"Create a Sending Domain","children":[{"anchor":"#sending-domains-post-create-a-sending-domain","title":"Create a Sending Domain"}]},{"anchor":"#sending-domains-verify-a-sending-domain","title":"Verify a Sending Domain","children":[{"anchor":"#sending-domains-post-verify-a-sending-domain","title":"Verify a Sending Domain","children":[{"anchor":"#header-verify-via-dns","title":"Verify via DNS"},{"anchor":"#header-dns-object","title":"DNS Object"},{"anchor":"#header-verify-via-mailbox","title":"Verify via mailbox"},{"anchor":"#header-trigger-a-verification-email","title":"Trigger a verification email"},{"anchor":"#header-validate-the-verification-token","title":"Validate the verification token"},{"anchor":"#header-returns","title":"Returns"}]}]},{"anchor":"#sending-domains-retrieve-a-sending-domain","title":"Retrieve a Sending Domain","children":[{"anchor":"#sending-domains-get-retrieve-a-sending-domain","title":"Retrieve a Sending Domain"}]},{"anchor":"#sending-domains-update-a-sending-domain","title":"Update a Sending Domain","children":[{"anchor":"#sending-domains-put-update-a-sending-domain","title":"Update a Sending Domain"}]},{"anchor":"#sending-domains-delete-a-sending-domain","title":"Delete a Sending Domain","children":[{"anchor":"#sending-domains-delete-delete-a-sending-domain","title":"Delete a Sending Domain"}]},{"anchor":"#sending-domains-list-all-sending-domains","title":"List all Sending Domains","children":[{"anchor":"#sending-domains-get-list-all-sending-domains","title":"List all Sending Domains"}]},{"anchor":"#sending-domains-list-dkim-keys","title":"List DKIM Keys","children":[{"anchor":"#sending-domains-get-list-dkim-keys","title":"List DKIM Keys"}]},{"anchor":"#sending-domains-create-a-dkim-key","title":"Create a DKIM Key","children":[{"anchor":"#sending-domains-post-create-a-dkim-key","title":"Create a DKIM Key"}]},{"anchor":"#sending-domains-retrieve-a-dkim-key","title":"Retrieve a DKIM Key","children":[{"anchor":"#sending-domains-get-retrieve-a-dkim-key","title":"Retrieve a DKIM Key"}]},{"anchor":"#sending-domains-update-a-dkim-key","title":"Update a DKIM Key","children":[{"anchor":"#sending-domains-put-update-a-dkim-key","title":"Update a DKIM Key"}]},{"anchor":"#sending-domains-delete-a-dkim-key","title":"Delete a DKIM Key","children":[{"anchor":"#sending-domains-delete-delete-a-dkim-key","title":"Delete a DKIM Key"}]},{"anchor":"#sending-domains-verify-a-dkim-key","title":"Verify a DKIM Key","children":[{"anchor":"#sending-domains-post-verify-a-dkim-key","title":"Verify a DKIM Key"}]}]}],"meta":{"title":"Sending Domains API","description":"Manage sending domains, which are used to indicate who an email is from.","full":false},"fields":{"path":"/api/sending-domains/"}}},"pageContext":{"file":"sending-domains.apib"}},"staticQueryHashes":["1319884646","1428769721","3859448388"]}