Allo

Delete inbox

Deletes the inbox. Conversations are not affected. With user id , an inbox with no source in a workspace the caller manages returns 404 , and an inbox that…

DELETE/v2/api/inboxes/{inbox_id}

Behavior

Deletes the inbox and returns 204 with no body. The conversations it showed are not affected and stay on their lines.

Pass the user_id query parameter to delete a teammate's inbox. Only admins and managers of the teammate's workspace can do that. An inbox with no source in a workspace the caller manages returns 404. An inbox that also holds lines from another workspace returns 403: only the teammate can delete it.

Errors

StatusCodeWhen
403FORBIDDENuser_id is set and the caller is not an admin or manager of that teammate's workspace, or the inbox also holds lines from another workspace
404INBOX_NOT_FOUNDNo inbox with this ID belongs to the inbox owner, or, with user_id, it has no source in a workspace the caller manages

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Path parameters

inbox_idstringrequired

Inbox ID (inb-*).

Query parameters

user_idstring

Act on a teammate's inbox (usr-*). The caller must be an admin or manager of that teammate's workspace, and only reaches inboxes and sources in workspaces they manage. Omit to act on your own inboxes.

Responses

204Inbox deleted
401
403
404
429