Skip to content

Set Auto Warmup

POST
/provider-domains/{domain_id}/auto-warmup

Turn automatic warmup enrolment on or off for this domain. ON COMMITS SPEND.

ON: every mailbox bought on this domain from now on is enrolled in warmup automatically, and warmup is a RECURRING monthly credit charge per mailbox (GET /provider-domains/pricing has the figure). It is the default.

OFF: new mailboxes are not enrolled and not billed for warmup. It does NOT stop warmup already running on existing mailboxes - use POST /warmup/{mailbox_id}/disable for that - and it does not affect warmup you start by hand.

Authorizations

Parameters

Path Parameters

domain_id
required

Sending domain id (provider_domains.id) - from GET /provider-domains

integer

Sending domain id (provider_domains.id) - from GET /provider-domains

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Turn automatic warmup enrolment on or off for this domain.

ON means every mailbox bought on this domain is enrolled in warmup automatically, which is a RECURRING credit charge per mailbox.

object
enabled
required

True enrols new mailboxes automatically and bills warmup for them

boolean

Responses

200

Successful Response

object
data
required

An open envelope for one provider/deliverability result.

Open on purpose. These payloads are provider state and advisory reads whose contents grow with the product, and a dropped field reads as “nothing to report” rather than “we did not tell you”. Every value passes through scrub_vendor_names on the way in.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string