Mailboxes

Setup Warmup

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.

post/warmup/setup

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/warmup/setup
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

mailbox_idinteger required
providerstring required

The warmup provider to enrol with.

warmup_settingsobject nullable

Provider-specific settings. Open because the accepted keys differ per provider and change with them - the app passes this through untouched, and a closed mirror here would drop a setting the provider supports.

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.