Mailbox Refresh
Ask for a mail check of your mailboxes now, and follow it until it ends.
/inbox/refreshRequires inbox:refresh on an API key; a sign-in session or an MCP sign-in is refused with 403 An API key is required. tRPC context.inbox.refreshStatus, MCP get_inbox_refresh.
Reports each reachable mailbox's latest check, and any older check still open, with retryNotBefore. Poll every few seconds while a check is queued or running; it never starts a check. available is false when no enabled mailbox you may reach syncs the inbox's folder, so a check would bring nothing in.
Authorization
apiKey In: header
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/inbox/refresh"{ "available": true, "unavailableReason": "string", "checks": [ { "id": "string", "state": "queued", "requestedAt": "string", "reason": "scope" } ], "retryNotBefore": "string"}/inbox/refreshRequires inbox:refresh on an API key, which includes inbox:read; a sign-in session or an MCP sign-in is refused with 403 An API key is required. tRPC context.inbox.refresh (a mutation), MCP refresh_inbox. Only owners and admins can add inbox:refresh to a key.
Asks for a mail check of each enabled mailbox the key may reach, the same check a member's Refresh in the inbox starts, and answers at once with the checks; it does not wait for mail. Poll GET /inbox/refresh until no check is queued or running; new support mail then shows in GET /tickets and the Needs reply feed once it is classified. Send no body, or {}.
- A call while a mailbox's check is open, or within 10 seconds after it ends, joins that check and starts nothing;
retryNotBeforesays when a new check can start. Repeating a call is safe. - A key limited to some connections checks only their mailboxes. A mailbox with no connection, as on organizations connected before connections existed, is out of every key's reach.
checksis empty when the key reaches none. - A check reads the mailbox; it never sends email or changes a message.
After a 500, read the status before calling again: the check may have started.
Authorization
apiKey In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/inbox/refresh" \ -H "Content-Type: application/json" \ -d '{}'{ "checks": [ { "id": "string", "state": "queued", "requestedAt": "string" } ], "retryNotBefore": "string"}