{"componentChunkName":"component---src-templates-api-js","path":"/api/inbound-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":"Inbound Domains API"}}},{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"description"},"value":{"element":"string","content":"Manage inbound domains, which enable you to receive emails."}}}]}},"content":[{"element":"category","meta":{"classes":{"element":"array","content":[{"element":"string","content":"resourceGroup"}]},"title":{"element":"string","content":"Inbound Domains"}},"content":[{"element":"copy","content":"Inbound Domains allow you to receive emails using SparkPost.\nWhen combined with [Relay Webhooks](/api/relay-webhooks/), SparkPost can parse the emails sent to the inbound domain and post their contents to your server.\n\n## Configuring MX records\n\nIn order to use an inbound domain, you will need to add MX records to your DNS settings.\nThe DNS settings required depend on whether you have a US, EU, Enterprise account.\n\n### US Accounts\n\n| Name               | Type | Data                  | Priority |\n| ------------------ | ---- | --------------------- | -------- |\n| `<inbound domain>` | MX   | rx1.sparkpostmail.com | 10       |\n| `<inbound domain>` | MX   | rx2.sparkpostmail.com | 10       |\n| `<inbound domain>` | MX   | rx3.sparkpostmail.com | 10       |\n\n### EU Accounts\n\n| Name               | Type | Data                     | Priority |\n| ------------------ | ---- | ------------------------ | -------- |\n| `<inbound domain>` | MX   | rx1.eu.sparkpostmail.com | 10       |\n| `<inbound domain>` | MX   | rx2.eu.sparkpostmail.com | 10       |\n| `<inbound domain>` | MX   | rx3.eu.sparkpostmail.com | 10       |\n\n### Enterprise Accounts\n\nEnterprise MX records are specific to each account.\nThey usually follow the format of `<tenant>.mx.e.sparkpost.com`, where `<tenant>` is unique to your account.\nPlease check with your TAM if you are unsure of the setting in your own environment.\n\n| Name               | Type | Data                          | Priority |\n| ------------------ | ---- | ----------------------------- | -------- |\n| `<inbound domain>` | MX   | `<tenant>.mx.e.sparkpost.com` | 10       |\n\n## Inbound Domain Object\n\n<DataStructure id=\"399d812c1a99c235b184abd5f86487eb\"   sample=\"%7B%0A%20%20%20%20%22domain%22%3A%20%22indbound.example.com%22%0A%7D\"></DataStructure>"},{"element":"resource","meta":{"title":{"element":"string","content":"Create an Inbound Domain"}},"attributes":{"href":{"element":"string","content":"/v1/inbound-domains"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Create an Inbound Domain"}},"attributes":{"href":{"element":"string","content":"/v1/inbound-domains"}},"content":[{"element":"copy","content":"<DataStructure id=\"7da0a0945fe8dcc61286d3020b7325a1\"  ></DataStructure>"},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n    \"domain\": \"indbound.example.com\"\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"}}}]},{"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"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n    \"domain\": \"indbound.example.com\"\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"409"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"resource conflict\",\n              \"description\": \"An inbound domain with similar attributes already exists\",\n              \"code\": \"1602\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Retrieve an Inbound Domain"}},"attributes":{"href":{"element":"string","content":"/v1/inbound-domains/{domain}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Retrieve an Inbound Domain"}},"attributes":{"href":{"element":"string","content":"/v1/inbound-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":"indbound.example.com"}}}]}},"content":[{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"results\": {\n          \"domain\": \"indbound.example.com\"\n      }\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"404"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"resource not found\",\n              \"code\": \"1600\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Delete an Inbound Domain"}},"attributes":{"href":{"element":"string","content":"/v1/inbound-domains/{domain}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Delete an Inbound Domain"}},"attributes":{"href":{"element":"string","content":"/v1/inbound-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":"indbound.example.com"}}}]}},"content":[{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"DELETE"}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"}}}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"DELETE"}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"404"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"resource not found\",\n              \"code\": \"1600\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"DELETE"}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"409"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"resource conflict\",\n              \"description\": \"Domain currently being used in a relay-webhook. Please delete the relay-webhook first.\",\n              \"code\": \"1602\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"List all Inbound Domains"}},"attributes":{"href":{"element":"string","content":"/v1/inbound-domains"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"List all Inbound Domains"}},"attributes":{"href":{"element":"string","content":"/v1/inbound-domains"}},"content":[{"element":"copy","content":"Returns an array with all your inbound domains."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"}}},{"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\": \"indbound.example.com\"\n          },\n          {\n              \"domain\": \"inbounddomain2.test.com\"\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":"399d812c1a99c235b184abd5f86487eb"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Domain (or subdomain) name for which SparkPost will receive inbound emails. Your DNS provider's MX record for this domain must point back to SparkPost."}},"content":{"key":{"element":"string","content":"domain"},"value":{"element":"string"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"7da0a0945fe8dcc61286d3020b7325a1"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Domain name for which SparkPost will receive inbound emails."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"domain"},"value":{"element":"string"}}}]}}]}]},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":6},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":2726},{"element":"number","content":13}]}]}]}},"content":"empty request message-body"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":6},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":3350},{"element":"number","content":13}]}]}]}},"content":"empty request message-body"},{"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":3207},{"element":"number","content":68}]}]}]}},"content":"the resource '/v1/inbound-domains/{domain}' is already defined"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":6},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":4160},{"element":"number","content":13}]}]}]}},"content":"empty request message-body"},{"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":4055},{"element":"number","content":56}]}]}]}},"content":"the resource '/v1/inbound-domains' is already defined"}]},"TableOfContents":[{"anchor":"#inbound-domains","title":"Inbound Domains","children":[{"anchor":"#header-configuring-mx-records","title":"Configuring MX records"},{"anchor":"#header-us-accounts","title":"US Accounts"},{"anchor":"#header-eu-accounts","title":"EU Accounts"},{"anchor":"#header-enterprise-accounts","title":"Enterprise Accounts"},{"anchor":"#header-inbound-domain-object","title":"Inbound Domain Object"},{"anchor":"#inbound-domains-create-an-inbound-domain","title":"Create an Inbound Domain","children":[{"anchor":"#inbound-domains-post-create-an-inbound-domain","title":"Create an Inbound Domain"}]},{"anchor":"#inbound-domains-retrieve-an-inbound-domain","title":"Retrieve an Inbound Domain","children":[{"anchor":"#inbound-domains-get-retrieve-an-inbound-domain","title":"Retrieve an Inbound Domain"}]},{"anchor":"#inbound-domains-delete-an-inbound-domain","title":"Delete an Inbound Domain","children":[{"anchor":"#inbound-domains-delete-delete-an-inbound-domain","title":"Delete an Inbound Domain"}]},{"anchor":"#inbound-domains-list-all-inbound-domains","title":"List all Inbound Domains","children":[{"anchor":"#inbound-domains-get-list-all-inbound-domains","title":"List all Inbound Domains"}]}]}],"meta":{"title":"Inbound Domains API","description":"Manage inbound domains, which enable you to receive emails.","full":false},"fields":{"path":"/api/inbound-domains/"}}},"pageContext":{"file":"inbound-domains.apib"}},"staticQueryHashes":["1319884646","1428769721","3859448388"]}