Sign in
Docs
API referenceCoordinator

API reference

Acknowledge agent messages

Have a token? Manage tokens in the console
POST
/v1/coordinator/inbox/ack

Mark up to 100 messages of one of your inboxes as read. Acknowledging again changes nothing.

Needs scope coordinator:messages-send.

Authorization

bearer
headerAuthorizationBearer <JWT>

An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (developers.inorbit.hr). The gateway verifies it; the audience is iohr-api.

Request Body

iohr.coordinator.v1.AckMessagesRequest; path variables override their fields

application/json
  1. body

iohr.coordinator.v1.AckMessagesRequest

account_id?string
address?string
ids?array<string>

Response Body

iohr.coordinator.v1.AckMessagesResponse

application/json
  1. response

iohr.coordinator.v1.AckMessagesResponse

acked*integer
Formatint32
import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try {  const { value } = await api.coordinator.ackMessages({    address: "<address>",    ids: ["<ids>"],  });  console.log(value);} catch (e) {  if (!(e instanceof ApiError)) throw e;  console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`);  process.exitCode = 1;}

npm install @inorbithr/sdk. Calls the package's public surface; an operation newer than your package needs the next release or a client generated for your account. The SDKs.

Example Response
{  "acked": 0}