Skip to main content
Use this endpoint to update an existing prescription. Common uses include changing the status (e.g. to completed or cancelled), updating refill counts, or adding clinical notes. Send only the fields you want to change.

Request

PATCH https://api.clinikapi.com/v1/prescriptions/{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 prescription to update.

Body

status
string
Updated status. One of: active, on-hold, cancelled, completed, draft.
refills
integer
Updated refill count (0–99).
dosageText
string
Updated dosage instructions.
note
string
Updated clinical note.
substitutionAllowed
boolean
Updated substitution preference.

Response

Returns 200 OK with the complete updated prescription.
data.id
string
Prescription ID.
data.status
string
Updated status.
meta
object
Standard response metadata.

Examples

curl

curl -X PATCH https://api.clinikapi.com/v1/prescriptions/rx_mno678 \
  -H "x-api-key: clk_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "completed",
    "note": "Patient completed full course of treatment."
  }'

TypeScript SDK

import { ClinikAPI } from "@clinikapi/sdk";

const client = new ClinikAPI({ apiKey: "clk_live_abc123" });

await client.prescriptions.update("rx_mno678", {
  status: "completed",
  note: "Patient completed full course of treatment.",
});