Inbound Domains

Inbound Domains allow you to receive emails using SparkPost. When combined with Relay Webhooks, SparkPost can parse the emails sent to the inbound domain and post their contents to your server.

In order to use an inbound domain, you will need to add MX records to your DNS settings.

MX Records for US Accounts

Name	Type	Data	Priority
<inbound domain>	MX	rx1.sparkpostmail.com	10
<inbound domain>	MX	rx2.sparkpostmail.com	10
<inbound domain>	MX	rx3.sparkpostmail.com	10

MX Records for EU Accounts

Name	Type	Data	Priority
<inbound domain>	MX	rx1.eu.sparkpostmail.com	10
<inbound domain>	MX	rx2.eu.sparkpostmail.com	10
<inbound domain>	MX	rx3.eu.sparkpostmail.com	10

Regional Endpoints

Please use the appropriate API endpoint based on your workspace region:

• EU workspaces: https://email.eu-west-1.api.bird.com

• US workspaces: https://email.us-west-1.api.bird.com

List all Inbound Domains

get

https://email.eu-west-1.api.bird.com/apihttps://email.us-west-1.api.bird.com/api

/workspaces/{workspaceId}/reach/inbound-domains

Returns an array with all your inbound domains.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

API key for authentication. Format: AccessKey <token> or Bearer <token>.

Path parameters

workspaceIdstring · uuidRequired

The ID of the workspace

Responses

200

Successfully retrieved inbound domains list

application/json

get

/workspaces/{workspaceId}/reach/inbound-domains

HTTPcURLJavaScriptPython

GET /api/workspaces/{workspaceId}/reach/inbound-domains HTTP/1.1
Host: email.eu-west-1.api.bird.com
Authorization: YOUR_API_KEY
Accept: */*

200

Successfully retrieved inbound domains list

{
  "results": [
    {
      "domain": "text"
    }
  ]
}

Create an Inbound Domain

post

https://email.eu-west-1.api.bird.com/apihttps://email.us-west-1.api.bird.com/api

/workspaces/{workspaceId}/reach/inbound-domains

Create an inbound domain by providing an inbound domain object as the POST request body.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

API key for authentication. Format: AccessKey <token> or Bearer <token>.

Path parameters

workspaceIdstring · uuidRequired

The ID of the workspace

Body

application/json

domainstringRequired

Domain name for which SparkPost will receive inbound emails. Your DNS provider's MX record for this domain must point back to SparkPost.

Responses

200

Inbound domain created successfully

No content

409

An inbound domain with similar attributes already exists

application/json

post

/workspaces/{workspaceId}/reach/inbound-domains

HTTPcURLJavaScriptPython

POST /api/workspaces/{workspaceId}/reach/inbound-domains HTTP/1.1
Host: email.eu-west-1.api.bird.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "domain": "text"
}

No content

Retrieve an Inbound Domain

get

https://email.eu-west-1.api.bird.com/apihttps://email.us-west-1.api.bird.com/api

/workspaces/{workspaceId}/reach/inbound-domains/{domain}

Retrieve an inbound domain by specifying its domain name in the URI path.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

API key for authentication. Format: AccessKey <token> or Bearer <token>.

Path parameters

workspaceIdstring · uuidRequired

The ID of the workspace

domainstringRequired

The inbound domain name

Responses

200

Successfully retrieved inbound domain

application/json

404

Resource could not be found

application/json

get

/workspaces/{workspaceId}/reach/inbound-domains/{domain}

HTTPcURLJavaScriptPython

GET /api/workspaces/{workspaceId}/reach/inbound-domains/{domain} HTTP/1.1
Host: email.eu-west-1.api.bird.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "results": {
    "domain": "text"
  }
}

Delete an Inbound Domain

delete

https://email.eu-west-1.api.bird.com/apihttps://email.us-west-1.api.bird.com/api

/workspaces/{workspaceId}/reach/inbound-domains/{domain}

Delete an inbound domain by specifying its domain name in the URI path.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

API key for authentication. Format: AccessKey <token> or Bearer <token>.

Path parameters

workspaceIdstring · uuidRequired

The ID of the workspace

domainstringRequired

The inbound domain name

Responses

200

Inbound domain deleted successfully

No content

404

Resource could not be found

application/json

409

Domain currently being used in a relay-webhook

application/json

delete

/workspaces/{workspaceId}/reach/inbound-domains/{domain}

HTTPcURLJavaScriptPython

DELETE /api/workspaces/{workspaceId}/reach/inbound-domains/{domain} HTTP/1.1
Host: email.eu-west-1.api.bird.com
Authorization: YOUR_API_KEY
Accept: */*

No content