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
workspace_id
integer
required

ID of the workspace to add the domain to.

domain
string
required

Domain or subdomain to connect (ex. example.com or mail.example.com). A leading http://, https:// or www. is removed and the value is lower-cased.

Required string length: 1 - 253
Example:

"example.com"

Response

Domain Added

id
integer
required
read-only

ID for this domain.

workspace_id
integer | null
required
read-only

ID of the workspace associated with this domain.

domain
string
required
read-only

The domain name (ex. example.com, foo.example.com).

warmup_days_remaining
integer
required
read-only

Number of days remaining in the domain's warmup period.

status
enum<string>
required

Current status of the domain. creating while the domain is being set up, warmup once setup is done and the domain is warming up, active once warmup is complete, deleting while it's being removed, error if setup or deletion failed, and ns_mismatch if the domain's nameserver records no longer point to us.

Available options:
creating,
error,
warmup,
active,
deleting,
ns_mismatch
nameservers
string[]
required
read-only

Nameservers that must be added as NS records for this domain at your DNS provider.

email_account_count
integer
required
read-only

Number of email accounts created for this domain.

created_on
string<date-time>

Datetime when the domain was created. ISO format date string in UTC timezone.

deletion_started_on
string<date-time> | null

Datetime when the domain deletion process started. ISO format date string in UTC timezone.

setup_complete
boolean

Flag indicating whether the domain setup is complete.

naming_strategy
enum<string>

Naming strategy used for email generation during domain setup.

  • random - random
  • male - male
  • female - female
  • custom - custom
Available options:
random,
male,
female,
custom
custom_name
string | null

Custom name used in domain setup when custom naming strategy is used.

Maximum string length: 500
redirect_subdomains_to
string | null

The URL to which subdomains are redirected, if set.

warmup_active_days
integer

Number of days the warmup process has been active.

Required range: 0 <= x <= 2147483647
current_setup_stage
integer

Setup progress: 1 once the domain is added and waiting for nameserver records, 4 once email accounts are generated, and 5 once mail server setup has started. setup_complete becomes true when setup finishes.

Required range: -2147483648 <= x <= 2147483647
domain_usable_from
string<date-time>

Datetime from which the domain can be used to send campaigns. ISO format date string in UTC timezone.

warmup_running
boolean

Whether warmup is currently running for this domain.

is_blocked
boolean

Whether this domain is blocked from being used in new campaigns.