Deliverability

Set Autopilot Preferences

Replace the org's autopilot preferences. mode='auto' AUTHORISES SPEND.

In auto the autopilot retires failing mailboxes and buys replacements on its own, without a human decision, until it has done max_auto_retirements_per_month retirements or spent monthly_spend_ceiling_credits credits this calendar month - whichever comes first. Past either limit it falls back to queueing for approval for the rest of the month.

In approval (the default) nothing is retired or bought without a person saying yes, and the ceilings are inert.

REPLACES all three fields; there is no partial update. Org admins and owners only - the app gates this the same way.

put/deliverability/autopilot/preferences

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/deliverability/autopilot/preferences
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

mode'approval' | 'auto' required

'approval' queues every retirement for a human; 'auto' lets the autopilot act and SPEND

max_auto_retirements_per_monthinteger required

Ceiling on automatic retirements per calendar month

monthly_spend_ceiling_creditsinteger required

Ceiling on credits the autopilot may spend per calendar month

Response

Successful Response

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

Changes

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