Skip to content

Update Warmup Settings

PATCH
/warmup/{mailbox_id}/settings

Change how an already-running warmup behaves.

The body is OPEN and forwarded as-is, matching the app, which types this parameter as a bare Dict[str, Any] and hands it to the provider. Closing it here would reject a setting the provider supports.

Authorizations

Parameters

Path Parameters

mailbox_id
required

Mailbox id.

integer

Mailbox id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Change how an already-running warmup behaves.

OPEN (extra="allow"), and deliberately: the app types this parameter as a bare Dict[str, Any] and forwards it to the warmup provider untouched. The accepted keys differ per provider and change with them, so a closed mirror here would reject a setting the provider supports - and the app would have accepted it.

object
key
additional properties
any

Responses

200

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