Skip to main content
Use this endpoint to amend a submitted intake form — for example, to add a newly reported allergy or transition the status from in-progress to completed. When you provide items, the updated list replaces the existing one for those linkId entries.

​
Request

PATCH https://api.clinikapi.com/v1/intakes/: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 intake to update (e.g. intake_abc123).

​
Body

​
status
string
Updated intake status. One of: in-progress, completed, amended, stopped.
​
items
array
Replacement question-answer pairs. Follows the same structure as the submit request. Each item requires a linkId and an answer array.
​
authored
string
ISO 8601 timestamp to update the authored date.

​
Response

Returns 200 OK with the full updated intake resource.
​
data.id
string
The intake ID.
​
data.status
string
Updated status value.
​
data.items
array
The updated question-answer pairs.
​
meta
object
Standard response metadata including requestId, timestamp, status, and rate-limit fields.

​
Examples

​
curl

curl -X PATCH https://api.clinikapi.com/v1/intakes/intake_abc123 \
  -H "x-api-key: clk_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "amended",
    "items": [
      {
        "linkId": "allergy-list",
        "text": "Please list your allergies",
        "answer": [
          { "valueString": "Penicillin" },
          { "valueString": "Shellfish" },
          { "valueString": "Latex" }
        ]
      }
    ]
  }'

​
TypeScript SDK

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

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

const { data } = await clinik.intakes.update('intake_abc123', {
  status: 'amended',
  items: [
    {
      linkId: 'allergy-list',
      text: 'Please list your allergies',
      answer: [
        { valueString: 'Penicillin' },
        { valueString: 'Shellfish' },
        { valueString: 'Latex' }, // newly reported
      ],
    },
  ],
});

console.log(data.status); // 'amended'