Skip to content

Setup Warmup

POST
/warmup/setup

Enrol a mailbox with a warmup provider.

warmup_settings is passed through untouched: the accepted keys differ per provider and change with them, so this contract does not second-guess what the provider takes.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Put a mailbox onto a warmup provider.

object
mailbox_id
required
integer
provider
required

The warmup provider to enrol with.

string
warmup_settings
Any of:
object
key
additional properties
any

Responses

201

Successful Response

object
data
required

An open envelope for a test, a schedule or a warmup report.

Open because placement results carry one panel per seed provider and the provider set changes; a closed model would drop a panel, and a missing panel on a deliverability report reads as “we did not test there” when the truth may be “you did not land there”.

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
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

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