API referenceDecisions
API reference
Update a work item
Have a token? Manage tokens in the console
PATCH
Set an item in progress, blocked or done, change its notes, or add links. Only its claimant or a person marks it done.
Needs scope decisions:write.
bearerheader
AuthorizationBearer <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.
item_id*stringThe work item.
iohr.work.v1.UpdateRequest; path variables override their fields
application/json- body
iohr.work.v1.UpdateRequest
account_id?stringitem_id?stringlinks?array<string>notes?stringstate?stringiohr.work.v1.UpdateResponse
application/json- response
iohr.work.v1.UpdateResponse
item?iohr.work.v1.WorkItem
SDK
HTTP
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.work.update("<item_id>", { links: ["<links>"], notes: "<notes>", state: "<state>", }); 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
{ "item": { "account_id": "string", "claimed_by": "string", "claimed_via": "string", "created_at": "string", "created_by": "string", "document_id": "string", "handed_to": "string", "handoff": "string", "item_id": "string", "links": [ "string" ], "notes": "string", "space_id": "string", "state": "string", "title": "string", "updated_at": "string", "updated_by": "string" }}