Sign in
Docs
API referenceCases

API reference

Save a client case

Have a token? Manage tokens in the console
PUT
/v1/cases/client-cases/{case_id}

Save a new version of a client case; earlier versions are kept. Text and links only, never a figure.

Needs scope cases:write.

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.

Path Parameters

case_id*string

The client case's id, cas_ and 32 hex characters, from List client cases.

Request Body

iohr.cases.v1.SaveClientCaseRequest; path variables override their fields

application/json
  1. body

iohr.cases.v1.SaveClientCaseRequest

base_version?integer
Formatint32
case_id?string
note?string
text?

iohr.cases.v1.StudyText

Response Body

iohr.cases.v1.SaveClientCaseResponse

application/json
  1. response

iohr.cases.v1.SaveClientCaseResponse

client_case?

iohr.cases.v1.ClientCase

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.saveClientCase("<case_id>", { note: "<note>" });  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
{  "client_case": {    "case_id": "string",    "company": "string",    "created_at": "string",    "created_by": "string",    "current_version": 0,    "plan_id": "string",    "published_version": 0,    "slug": "string",    "status": "string",    "study_id": "string",    "text": {      "en": {        "markdown": "string",        "summary": "string",        "title": "string"      },      "hr": {        "markdown": "string",        "summary": "string",        "title": "string"      }    },    "updated_at": "string"  }}