Start Inbox Mailbox Sync
POST /inbox/mailboxes/{mailbox}/sync
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.
Authorizations
Parameters
Path Parameters
The mailbox ADDRESS, e.g. [email protected]. Not a numeric id.
The mailbox ADDRESS, e.g. [email protected]. Not a numeric id.
Query Parameters
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.
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.
Header Parameters
Responses
202
Successful Response
object
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.
object
object
Whether there are more pages
Items per page
Current page number (1-indexed)
Total number of items
422
Validation Error