Agent inboxes

Update an inbox

PATCH/v1/agent/inbox/:id

Changes an inbox's settings, including its wake hook.

Parameters

Path parameters1

idstringRequired

Destination ID (dst_…).

Body parameters3

wake?object

{ enabled, url, after_seconds, max_seconds, mode, loop_limit }, plus auth and headers for a URL behind a gateway.

lease_seconds?integer

Lease length.

allowed_ack?string

Permitted ack modes.

Returns

200The sample response is on the right.Errors return error and message; see Errors and limits.

PATCHUpdate an inbox

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

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

import os, requests

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

200Response

{
  "id": "dst_7q1c…",
  "name": "billing-agent",
  "type": "inbox",
  "status": "active",
  "created": 1762761600000,
  "lease_seconds": 300,
  "waiting": 3,
  "leased": 1,
  "oldest_at": 1762761700000,
  "wake": {
    "enabled": false
  }
}

{"id":"dst_7q1c…","name":"billing-agent","type":"inbox","status":"active","created":1762761600000,"lease_seconds":300,"waiting":3,"leased":1,"oldest_at":1762761700000,"wake":{"enabled":false}}