Skip to main content
POST
Bulk provision domains

Authorizations

X-API-Key
string
header
required

Query Parameters

subscriptionHandle
string
required

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

associate-key
boolean

If present and set to true, the domains will be associated with the api-key in the header. This means that this api-key must be used for inbound-api actions involving these domains (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 any existing domains will be overwritten with the ones in the request, 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
domains
object[]
Maximum array length: 1000

Response

The request was processed successfully. This does not necessarily mean all the domains in the request were successfully provisioned. See the CommentedDomain definition for more information.

successes
object[]
required
errors
object[]
required