---
title: "Start Inbox Mailbox Sync"
method: POST
path: "/inbox/mailboxes/{mailbox}/sync"
tags: ["AI Inbox"]
---

# Start Inbox Mailbox Sync

`POST /inbox/mailboxes/{mailbox}/sync`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/inbox/mailboxes/{mailbox}/sync`
- Auth: HTTP bearer

START POLLING this mailbox.

REACHES OUTSIDE GRAPH8: from here on the platform connects to the
customer's Google or IMAP server with their stored credentials, on a
schedule, until it is stopped. Classified `external`, so it needs
`inbox:run` rather than plain write.

It contacts no recipient - nothing is SENT by turning sync on. What it
can lead to is the AI answering on this mailbox, which is governed
separately by `auto_respond`.

Refuses with 400 if the mailbox is already running, so a retry is safe
rather than doubling the polling.

202 because the first sync round happens on the org-level worker's next
pass, not inside this request.

## Path parameters

- `mailbox` string, required: The mailbox ADDRESS, e.g. `sales@acme.com`. Not a numeric id.

## Query parameters

- `provider` 'google_mailbox' | 'smtp', required: How the mailbox is connected. REQUIRED and not inferred: the same address can be connected either way, and guessing would act on the wrong transport. Closed to a Literal so an unknown value is a 422 naming both, rather than a `ValueError` raised inside the handler.
- `display_name` string, nullable: Label shown beside the address.

## Headers

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

## Response `202`

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)