---
title: "Set Autopilot Preferences"
method: PUT
path: "/deliverability/autopilot/preferences"
tags: ["Deliverability"]
---

# Set Autopilot Preferences

`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

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.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- AutopilotPreferencesRequest: 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.
  - `mode` 'approval' | 'auto', required: 'approval' queues every retirement for a human; 'auto' lets the autopilot act and SPEND
  - `max_auto_retirements_per_month` integer, required: Ceiling on automatic retirements per calendar month
  - `monthly_spend_ceiling_credits` integer, required: Ceiling on credits the autopilot may spend per calendar month

## Response `200`

Successful Response

- ApiResponseMailboxDomainPayload
  - `data` MailboxDomainPayload, 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.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)