Mailboxes

Update Warmup 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.

patch/warmup/{mailbox_id}/settings

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/warmup/{mailbox_id}/settings
  • Auth: HTTP bearer

Path parameters

mailbox_idinteger required

Mailbox id.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

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

Response

Successful Response

dataDeliverabilityPayload 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".

Changes

No recorded changes to this operation across all 2 revisions of this API.