API reference
Add a note to a plan item
Append a note to an item. Notes are kept in order and never edited.
Needs scope coordinator:write.
bearerAuthorizationBearer <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.
plan_id*stringThe plan's id, from List plans.
item_id*stringThe item's id, from Get a plan.
iohr.coordinator.v1.NotePlanItemRequest; path variables override their fields
application/json- body
iohr.coordinator.v1.NotePlanItemRequest
account_id?stringbody?stringitem_id?stringplan_id?stringiohr.coordinator.v1.NotePlanItemResponse
application/json- response
iohr.coordinator.v1.NotePlanItemResponse
note?iohr.coordinator.v1.PlanNote
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.notePlanItem("<plan_id>", "<item_id>", { body: "<body>" }); 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.
{ "note": { "author": "string", "body": "string", "created_at": "string", "id": "string", "item_id": "string" }}