Inbox

Base URL: $CONSUMER_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 in-app messages addressed to the caller

Logs

GET /inbox

Returns the in-app messages addressed to the signed-in person across every utility, newest first, one cursor page at a time. Only messages with both a title and a body are listed, and archived messages are hidden unless include_archived is true. The caller must be a consumer identity that is not bound to a tenant; a staff or tenant-bound token receives 403. No account permission is needed, since the inbox belongs to the person.

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 The caller's inbox messages

Show attributes
dataarray of NotificationInboxItem · required

Inbox messages addressed to the caller, newest first.

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

True when another page follows; pass next_cursor as after to read it.

next_cursorstring · optional

Opaque cursor for the next page; present only when has_more is true.

Errors 400 · 401 · 403

curl -X GET "$CONSUMER_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 one of the caller's inbox messages as read

Logs

POST /inbox/{id}/read

Sets the read time on a message in the caller's own inbox and returns the updated message. The call is idempotent: a message already read keeps its original read time. A message addressed to anyone else, or that does not exist, returns 404. The caller must be a consumer identity that is not bound to a tenant.

Parameters

idstring · path · required

Identifier of a message in the caller's inbox.

Returns

200 Updated inbox message

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 401 · 403 · 404

curl -X POST "$CONSUMER_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 one of the caller's inbox messages

Logs

POST /inbox/{id}/archive

Sets the archive time on a message in the caller's own 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. A message addressed to anyone else, or that does not exist, returns 404. The caller must be a consumer identity that is not bound to a tenant.

Parameters

idstring · path · required

Identifier of a message in the caller's inbox.

Returns

200 Updated inbox message

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 401 · 403 · 404

curl -X POST "$CONSUMER_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"
}