Skip to main content
Use this endpoint to modify an existing clinical note. All body fields are optional — only the fields you include will be updated. A common use case is promoting a preliminary note to final after signing, or adding an addendum by setting docStatus to amended and updating content.

​
Request

PATCH https://api.clinikapi.com/v1/notes/:id

​
Headers

​
x-api-key
string
required
Your ClinikAPI secret key (clk_live_* or clk_test_*).
​
Content-Type
string
required
Must be application/json.

​
Path parameters

​
id
string
required
The ID of the note to update (e.g. note_abc123).

​
Body

​
title
string
Updated note title.
​
content
string
Updated note body. Replaces the existing content in full.
​
docStatus
string
Updated document status. One of: preliminary, final, amended.
​
authorId
string
Updated practitioner author ID.
​
encounterId
string
Updated encounter reference.
​
type
string
Updated note type. One of: progress-note, discharge-summary, consultation-note, history-and-physical, operative-note, procedure-note, referral-note, transfer-summary, other.
​
category
string
Updated category tag.
​
date
string
Updated clinically relevant date in YYYY-MM-DD format.

​
Response

Returns 200 OK with the updated note wrapped in the standard envelope. All fields reflect the post-update state.
​
data.id
string
Note ID.
​
data.docStatus
string
Updated document status.
​
data.content
string
Updated note content.
​
meta
object
Standard response metadata including requestId, timestamp, status, and rate-limit fields.

​
Examples

​
curl

curl -X PATCH https://api.clinikapi.com/v1/notes/note_abc123 \
  -H "x-api-key: clk_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "docStatus": "amended",
    "content": "## Subjective\nPatient reports compliance with lisinopril 20mg daily.\n\n## Addendum\nBP recheck at 4 weeks: 124/78 — at goal."
  }'

​
TypeScript SDK

import { Clinik } from '@clinikapi/sdk';

const clinik = new Clinik(process.env.CLINIKAPI_SECRET_KEY!);

const { data: note } = await clinik.notes.update('note_abc123', {
  docStatus: 'amended',
  content: '## Subjective\nPatient reports compliance with lisinopril 20mg daily.\n\n## Addendum\nBP recheck at 4 weeks: 124/78 — at goal.',
});

console.log(note.docStatus); // "amended"