Skip to content

Set Autopilot Preferences

PUT
/deliverability/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.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Replace the org’s deliverability-autopilot preferences.

mode='auto' authorises the autopilot to retire and REPLACE failing mailboxes without asking, up to monthly_spend_ceiling_credits of the org’s credits each month. That is why this is not an ordinary write.

object
max_auto_retirements_per_month
required

Ceiling on automatic retirements per calendar month

integer
<= 100
mode
required

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

string
Allowed values: approval auto
monthly_spend_ceiling_credits
required

Ceiling on credits the autopilot may spend per calendar month

integer
<= 500000

Responses

200

Successful Response

object
data
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.

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