Agent inboxes

Clear an inbox

POST/v1/agent/inbox/:id/clear

Drops the events waiting in an inbox.

Parameters

Path parameters1

idstringRequired

Destination ID (dst_…).

Returns

200A JSON object describing the result.Errors return error and message; see Errors and limits.

POSTClear an inbox

curl -X POST "https://api.getensue.com/v1/agent/inbox/dst_…/clear" \
  -H "authorization: Bearer $ENSUE_API_KEY"

const res = await fetch("https://api.getensue.com/v1/agent/inbox/dst_…/clear", {
  method: "POST",
  headers: {
    authorization: `Bearer ${process.env.ENSUE_API_KEY}`,
  },
});
console.log(await res.json());

import os, requests

res = requests.post(
    "https://api.getensue.com/v1/agent/inbox/dst_…/clear",
    headers={"authorization": f"Bearer {os.environ['ENSUE_API_KEY']}"},
)
print(res.json())

200Response

Returns a JSON object describing the result.