Inbox

Base URL: $BUSINESS_API

The object

idstring · required
tenant_idstring · required
intent_idstring · required
event_typestring · required
template_keystring · optional
titlestring · required
bodystring · required
resource_typestring · optional
resource_idstring · optional
created_atstring (date-time) · required
read_atstring (date-time) · optional
archived_atstring (date-time) · optional
The object
{
  "id": "not_2WyblSmD5mK7ZwWz32AntEotfiw",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "intent_id": "int_22Gr1MqNzCoLNQG9VCg3dYIRdQg",
  "event_type": "event type",
  "template_key": "template key",
  "title": "Fuga na Rua 3",
  "body": "Leitura confirmada no local.",
  "resource_type": "resource type",
  "resource_id": "res_2iAXhMsJzmqPnY6X5cMTJ6OBTSG",
  "created_at": "2026-11-19T09:30:00Z",
  "read_at": "2026-11-19T09:30:00Z",
  "archived_at": "2026-11-19T09:30:00Z"
}

List staff notification inbox

Logs

GET /inbox

List notification messages addressed to the authenticated utility staff member

Results are scoped to both the active utility tenant and the authenticated identity.

Parameters

limitinteger · query · optional

Maximum resources to return (default 20, maximum 100).

afterstring · query · optional

Opaque cursor returned by the previous page.

unread_onlyboolean · query · optional · default false

When true, return only messages that have not been marked read; accepts Go boolean strings (true, false, 1, 0, t, f) and returns 400 for anything else.

include_archivedboolean · query · optional · default false

When true, also return archived messages, which are hidden by default; accepts Go boolean strings and returns 400 for anything else.

Returns

200 Utility-scoped staff inbox messages

Show attributes
dataarray of NotificationInboxItem · required
Show child attributes
idstring · required
tenant_idstring · required
intent_idstring · required
event_typestring · required
template_keystring · optional
titlestring · required
bodystring · required
resource_typestring · optional
resource_idstring · optional
created_atstring (date-time) · required
read_atstring (date-time) · optional
archived_atstring (date-time) · optional
has_moreboolean · required
next_cursorstring · optional

Errors 403

Permissions business:notification-intents:read · Roles: admin, customer_service, owner

curl -X GET "$BUSINESS_API/inbox" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "data": [
    {
      "id": "not_2WyblSmD5mK7ZwWz32AntEotfiw",
      "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
      "intent_id": "int_22Gr1MqNzCoLNQG9VCg3dYIRdQg",
      "event_type": "event type",
      "template_key": "template key",
      "title": "Fuga na Rua 3",
      "body": "Leitura confirmada no local.",
      "resource_type": "resource type",
      "resource_id": "res_2iAXhMsJzmqPnY6X5cMTJ6OBTSG",
      "created_at": "2026-11-19T09:30:00Z",
      "read_at": "2026-11-19T09:30:00Z",
      "archived_at": "2026-11-19T09:30:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "next cursor"
}

Mark a staff inbox message as read

Logs

POST /inbox/{id}/read

Sets the read time on a message in the caller's own staff inbox and returns the updated message. The call is idempotent: a message already read keeps its original read time. Returns 404 when the message does not belong to the caller in this tenant.

Parameters

idstring · path · required

Identifier of a message in the authenticated staff member's inbox.

Returns

200 Updated inbox item

Show attributes
idstring · required
tenant_idstring · required
intent_idstring · required
event_typestring · required
template_keystring · optional
titlestring · required
bodystring · required
resource_typestring · optional
resource_idstring · optional
created_atstring (date-time) · required
read_atstring (date-time) · optional
archived_atstring (date-time) · optional

Errors 403 · 404

Permissions business:notification-intents:read · Roles: admin, customer_service, owner

curl -X POST "$BUSINESS_API/inbox/{id}/read" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "id": "not_2WyblSmD5mK7ZwWz32AntEotfiw",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "intent_id": "int_22Gr1MqNzCoLNQG9VCg3dYIRdQg",
  "event_type": "event type",
  "template_key": "template key",
  "title": "Fuga na Rua 3",
  "body": "Leitura confirmada no local.",
  "resource_type": "resource type",
  "resource_id": "res_2iAXhMsJzmqPnY6X5cMTJ6OBTSG",
  "created_at": "2026-11-19T09:30:00Z",
  "read_at": "2026-11-19T09:30:00Z",
  "archived_at": "2026-11-19T09:30:00Z"
}

Archive a staff inbox message

Logs

POST /inbox/{id}/archive

Sets the archive time on a message in the caller's own staff inbox and returns the updated message; archived messages are hidden from the inbox list unless include_archived is set. Archiving does not mark the message read, and repeating the call keeps the original archive time. Returns 404 when the message does not belong to the caller in this tenant.

Parameters

idstring · path · required

Identifier of a message in the authenticated staff member's inbox.

Returns

200 Updated inbox item

Show attributes
idstring · required
tenant_idstring · required
intent_idstring · required
event_typestring · required
template_keystring · optional
titlestring · required
bodystring · required
resource_typestring · optional
resource_idstring · optional
created_atstring (date-time) · required
read_atstring (date-time) · optional
archived_atstring (date-time) · optional

Errors 403 · 404

Permissions business:notification-intents:read · Roles: admin, customer_service, owner

curl -X POST "$BUSINESS_API/inbox/{id}/archive" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "id": "not_2WyblSmD5mK7ZwWz32AntEotfiw",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "intent_id": "int_22Gr1MqNzCoLNQG9VCg3dYIRdQg",
  "event_type": "event type",
  "template_key": "template key",
  "title": "Fuga na Rua 3",
  "body": "Leitura confirmada no local.",
  "resource_type": "resource type",
  "resource_id": "res_2iAXhMsJzmqPnY6X5cMTJ6OBTSG",
  "created_at": "2026-11-19T09:30:00Z",
  "read_at": "2026-11-19T09:30:00Z",
  "archived_at": "2026-11-19T09:30:00Z"
}