Inbox TriageTriage
Extend a lease
Extends your lease. Call it about every 2 minutes during a pass.
If the lease already ran out you get 200 with ok: false and reason: "no_lease". Begin again before you change more mail.
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 |
|---|---|---|---|
agentLabel |
string | Required | The same label you began with. |
Response
200 OK.
| Name | Type | Description |
|---|---|---|
ok |
boolean | true when the lease was extended. |
leaseExpiresAt |
string | The new expiry. |
reason |
string | no_lease when ok is false. |
Errors
| Status | Error | Meaning |
|---|---|---|
| 400 | invalid_request |
agentLabel is missing. |
| 404 | inbox_not_found |
The inbox id is wrong or the inbox was removed. |
| 409 | lease_busy |
Another agent holds the lease. The body also has ok: false, busy: true, heldBy, and leaseExpiresAt. |
| 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.