API reference
Mark a plan item shareable
Say whether one item of the plan may appear in the customer's view, with its public title and public proof links. An item is never shared unless marked.
Needs scope cases: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.
case_id*stringThe client case's id, cas_ and 32 hex characters, from List client cases.
iohr.cases.v1.SetItemShareableRequest; path variables override their fields
application/json- body
iohr.cases.v1.SetItemShareableRequest
case_id?stringproof_links?array<string>ref?stringshareable?booleantitle?stringiohr.cases.v1.SetItemShareableResponse
application/json- response
iohr.cases.v1.SetItemShareableResponse
item?iohr.cases.v1.CaseItem
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.cases.setItemShareable("<case_id>", { proof_links: ["<proof_links>"], ref: "<ref>", title: "<title>", }); 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.
{ "item": { "brief": "string", "plan": { "reason": "string", "ref": "string", "stage": "string", "status": "string", "stub": true }, "proof_links": [ "string" ], "public_title": "string", "shareable": true }}