Sync
Load older messages
Loads messages older than the synced window for one folder.
Stops at 1000 messages per folder. Not available for Microsoft yet (returns unsupported: true). Failures come back as ok: false with an error, still HTTP 200.
Headers
| Name | Type | Required | Description |
|---|---|---|---|
Authorization |
string | Required | Bearer followed by your API key. |
Content-Type |
string | Required | application/json |
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
string | Required | Inbox id from List inboxes, like inbox_lx2k9a1b. |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
folder |
string | Required | One of the inbox's synced folders, like INBOX. |
count |
number | Optional | How many to fetch. Default 50, max 200. |
Response
200 OK.
| Name | Type | Description |
|---|---|---|
ok |
boolean | false when the load failed. |
folder |
string | The folder you asked for. |
added |
number | Messages added by this call. |
total |
number | Messages now stored for the folder. |
exhausted |
boolean | true when there is nothing older left. |
windowNow |
number | The folder window size after this call. |
unsupported |
boolean | true for providers that cannot load older mail yet. |
needsReconnect |
boolean | true when the person has to reconnect. |
Errors
| Status | Error | Meaning |
|---|---|---|
| 400 | invalid_request |
folder is missing. |
| 404 | inbox_not_found |
The inbox id is wrong or the inbox was removed. |
| 409 | inbox_paused |
The person paused this inbox. They resume it on the Inboxes page. |
Any route can also return 401 for a bad key, 402 when the trial ended or payment failed, and 429 when you send too many requests. See Errors.