Skip to main content

Provision domain

POST 

/domains

Provision a single domain to use MailChannels Inbound.

Request

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

required

    domainhostnamerequired

    The domain name.

    subscriptionHandlestringrequired

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

    settings

    The abuse policy settings for the domain. These settings determine how spam messages are handled.

    abusePolicystringnullable

    The abuse policy

    Possible values: non-empty, [block, flag, quarantine]

    abusePolicyOverridebooleannullable

    If true, this abuse policy overrides the recipient abuse policy.

    spamHeaderNamestringnullable

    The spam header name to use if the abuse policy is set to 'flag'.

    Possible values: non-empty

    spamHeaderValuestringnullable

    The spam header value to use if the abuse policy is set to 'flag'.

    Possible values: non-empty

    adminsstring[]

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

    downstreamAddresses

    object[]

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

  • Array [

  • priorityintegerrequired

    The priority of the dowsntream address. Only addresses with the highest priority (the lowest numerical value) are selected.

    weightintegerrequired

    Downstream addresses are selected in proportion to their weights. For example, if there are two downstream addresses, A with weight 40, and B with weight 10, then A is selected 80% of the time and B is selected 20% of the time.

    portintegerrequired

    TCP port on which the downstream mail server is listening.

    targetstringrequired

    The canonical hostname of the host providing the service, ending in a dot.

    Possible values: <= 255 characters

  • ]

  • aliasesstring[]

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

Responses

The domain was already provisioned to use MailChannels Inbound.

Schema

    domainhostnamerequired

    The domain name.

    subscriptionHandlestringrequired

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

    settings

    The abuse policy settings for the domain. These settings determine how spam messages are handled.

    abusePolicystringnullable

    The abuse policy

    Possible values: non-empty, [block, flag, quarantine]

    abusePolicyOverridebooleannullable

    If true, this abuse policy overrides the recipient abuse policy.

    spamHeaderNamestringnullable

    The spam header name to use if the abuse policy is set to 'flag'.

    Possible values: non-empty

    spamHeaderValuestringnullable

    The spam header value to use if the abuse policy is set to 'flag'.

    Possible values: non-empty

    adminsstring[]

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

    downstreamAddresses

    object[]

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

  • Array [

  • priorityintegerrequired

    The priority of the dowsntream address. Only addresses with the highest priority (the lowest numerical value) are selected.

    weightintegerrequired

    Downstream addresses are selected in proportion to their weights. For example, if there are two downstream addresses, A with weight 40, and B with weight 10, then A is selected 80% of the time and B is selected 20% of the time.

    portintegerrequired

    TCP port on which the downstream mail server is listening.

    targetstringrequired

    The canonical hostname of the host providing the service, ending in a dot.

    Possible values: <= 255 characters

  • ]

  • aliasesstring[]

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