---
title: "Toggle Inbox Mailboxes"
method: PATCH
path: "/inbox/mailboxes/bulk"
tags: ["AI Inbox"]
---

# Toggle Inbox Mailboxes

`PATCH /inbox/mailboxes/bulk`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/inbox/mailboxes/bulk`
- Auth: HTTP bearer

Flip several mailboxes on or off by address, and optionally set
auto-respond on all of them in the same call.

PARTIALLY TOLERANT where activate is not: this one reports failures in the
body and still returns 200. Check `total_failed`.

`activate` is explicit rather than a toggle, so a retried request is
idempotent instead of putting the mailboxes back the way they were.

## Headers

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

## Request body

- MailboxToggleRequest: Flip several mailboxes on or off, and optionally set auto-respond. `activate` is explicit rather than a toggle, so a retried request is idempotent instead of flipping the state back.
  - `mailboxes` string[], required: Mailbox addresses.
  - `activate` boolean, required: True starts syncing, false stops it.
  - `auto_respond` boolean, nullable

## Response `200`

Successful Response

- ApiResponseInboxPayload
  - `data` InboxPayload, required: An open envelope for a comment, an assignment or a workspace. Open because a comment carries attachment refs and mention metadata that grow, and because an assignment result reports per-assignee outcomes.
  - `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)