Skip to main content
Use this endpoint to modify an existing patient record. Send only the fields you want to change — you do not need to include the full patient object. The response returns the complete updated patient.

Request

PATCH https://api.clinikapi.com/v1/patients/{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 patient to update (e.g. pt_abc123).

Body

Provide any subset of the patient fields you want to update. All fields are optional for this request.
firstName
string
Updated first name. Maximum 100 characters.
lastName
string
Updated last name. Maximum 100 characters.
email
string
Updated email address.
phone
string
Updated phone number. Maximum 20 characters.
gender
string
Updated gender. One of: male, female, other, unknown.
birthDate
string
Updated date of birth in YYYY-MM-DD format.
address
object
Updated address. Replaces the entire address object.

Response

Returns 200 OK with the complete updated patient resource.
data.id
string
The patient’s unique ID.
data.firstName
string
Patient’s current first name.
data.lastName
string
Patient’s current last name.
data.email
string
Patient’s current email address.
meta
object
Standard response metadata including requestId, timestamp, status, and rate-limit fields.

Examples

curl

curl -X PATCH https://api.clinikapi.com/v1/patients/pt_abc123 \
  -H "x-api-key: clk_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "+1-555-0199",
    "address": {
      "line": ["456 Oak Ave"],
      "city": "Chicago",
      "state": "IL",
      "postalCode": "60601",
      "country": "US"
    }
  }'

TypeScript SDK

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

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

const updated = await client.patients.update("pt_abc123", {
  phone: "+1-555-0199",
  address: {
    line: ["456 Oak Ave"],
    city: "Chicago",
    state: "IL",
    postalCode: "60601",
    country: "US",
  },
});

console.log(updated.data.phone); // "+1-555-0199"