Inboxes

Remove an inbox

DEL https://getinboxtriage.com/api/inboxes/{id}

Not available to API keys. Removing an inbox deletes its stored credential and synced mail, so the owner does it on the Inboxes page of the website.

Always returns 403 for an API key. Mail in the mailbox itself is never touched by removal.

Headers

Name	Type	Required	Description
`Authorization`	string	Required	Bearer followed by your API key.

Path parameters

Name	Type	Required	Description
`id`	string	Required	Inbox id from List inboxes, like inbox_lx2k9a1b.

Response

200 OK.

Name	Type	Description
`error`	string	owner_session_required.
`error_description`	string	A plain sentence that points to the Inboxes page.

Errors

Status	Error	Meaning
403	`owner_session_required`	API keys cannot remove inboxes. Use 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.

Request

curl -X DELETE "https://getinboxtriage.com/api/inboxes/inbox_lx2k9a1b" \
  -H "Authorization: Bearer $INBOX_TRIAGE_KEY"

const res = await fetch("https://getinboxtriage.com/api/inboxes/inbox_lx2k9a1b", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.INBOX_TRIAGE_KEY}`,
  },
});
const data = await res.json();

import os
import requests

res = requests.delete(
    "https://getinboxtriage.com/api/inboxes/inbox_lx2k9a1b",
    headers={"Authorization": f"Bearer {os.environ['INBOX_TRIAGE_KEY']}"},
)
print(res.json())

Response200

{
  "error": "owner_session_required",
  "error_description": "Remove an inbox from the Inboxes page while signed in as the owner. An API key cannot remove inboxes."
}