---
title: "Update Warmup Settings"
method: PATCH
path: "/warmup/{mailbox_id}/settings"
tags: ["Mailboxes"]
---

# Update Warmup Settings

`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

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.

## Path parameters

- `mailbox_id` integer, required: Mailbox id.

## Headers

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

## Request body

- UpdateWarmupSettingsRequest: 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 `200`

Successful Response

- ApiResponseDeliverabilityPayload
  - `data` DeliverabilityPayload, 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".
  - `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/89fc11143b70?raw)