Sign in

v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
DFYEmailAccountOrder

Get pre-warmed up domains

This endpoint will return a list of pre-warmed up domains available for order.<br/>These domains are set up and configured in advance, allowing for quick deployment of email services.<br/>Use this endpoint to retrieve available pre-warmed up domains before placing an order.<br/><br/><b>IMPORTANT: if the endpoint returns a list of empty domains - it's not a bug, please don't retry right away or report this as a bug - it simply means that there are no available pre-warmed up domains at the moment.</b>

Requires one of the following scopes: dfy_email_account_orders:read, dfy_email_account_orders:all, all:read, all:all

post/api/v2/dfy-email-account-orders/domains/pre-warmed-up-list

Request body

extensionsstring[]

A list of domain extensions to filter the results by. If not provided, all available extensions will be returned.

searchstring

A search string to filter the domains by. This can be a partial or full domain name.

Example request

{
  "extensions": [
    "com"
  ],
  "search": "acme.com"
}

Response

Default Response

domainsstring[]

List of pre-warmed up domains available for order

Example response

{
  "domains": [
    "acme.com"
  ],
  "domains_with_type": [
    {
      "domain": "acme.com",
      "account_type": 2
    }
  ]
}