Skip to main content
POST
curl

Authorizations

X-Api-Key
string
header
required

Your API key, sent as the value of the X-Api-Key header. In the dashboard, go to Integrations and open Deliveryman API Keys to create one.

Body

application/json
domain_id
integer
required

ID of the domain to set up.

naming_strategy
enum<string>
required

How the names of the domain's email accounts are generated. random uses a mix of male and female names, male and female use only male or only female names, and custom uses the names given in custom_names.

Available options:
random,
male,
female,
custom
country
string
required

Country whose common names are used to generate email account names (ex. United States). Not used for the custom naming strategy, but still required.

Required string length: 1 - 100
Example:

"United States"

custom_names
string[] | null

Required when naming_strategy is custom, and must be omitted otherwise. Up to 5 full names in Firstname Lastname format, using letters only. Every part of a name must be at least 2 characters long, and the first 2 letters of the first and last name must be different.

Required array length: 1 - 5 elements
Minimum string length: 1
Example:

Response

Setup Started

message
string
required

Human-readable description of the result or error.