Skip to main content
POST
Provision domain

Authorizations

X-API-Key
string
header
required

Query Parameters

associate-key
boolean

If present and set to true, the domain will be associated with the api-key that created it. This means that this api-key must be used for inbound-api actions involving this domain (for example adding safe/block list entries, etc).

overwrite
boolean

If present and set to true, the settings (domain settings, downstream addresses, aliases and admins) for the domain will be overwritten with the ones in the request if the domain already exists, unless a section is not included in the request or there is problem updating a setting in which case the previous settings are carried forward.

Body

application/json
domain
string<hostname>
required

The domain name.

subscriptionHandle
string
required

The subscription 'handle' that identifies the subscription that this domain should be provisioned against. Subscription handles can be retrieved from the /subscriptions endpoint.

admins
string[]
required

A list of email addresses that are the domain admins for the domain.

downstreamAddresses
object[]
required

The locations of mail servers to which messages will be delivered after filtering.

aliases
string[]
required

A list of aliases for the domain. Mail is accepted for these domains and routed to the downstreamAddresses defined for the domain.

settings
object

Response

The domain was already provisioned to use MailChannels Inbound.

domain
string<hostname>
required

The domain name.

subscriptionHandle
string
required

The subscription 'handle' that identifies the subscription that this domain should be provisioned against. Subscription handles can be retrieved from the /subscriptions endpoint.

admins
string[]
required

A list of email addresses that are the domain admins for the domain.

downstreamAddresses
object[]
required

The locations of mail servers to which messages will be delivered after filtering.

aliases
string[]
required

A list of aliases for the domain. Mail is accepted for these domains and routed to the downstreamAddresses defined for the domain.

settings
object