Skip to main content
POST
Create patient_logs

Authorizations

Authorization
string
header
required

API key from Developers → API Keys, sent as Authorization: Bearer .

Headers

Idempotency-Key
string

Any unique string (≤255 chars). A retry with the same key within 24 hours replays the original response (Idempotent-Replayed: true) instead of creating a second record.

Maximum string length: 255

Body

application/json
patient_id
integer
required

The patient whose timeline the entry sits on.

Required range: x >= 1
type
enum<string>
required

note (free-text notes), comms (patient communication), financial (billing), appt (appointments), membership (care plans), system (system-generated) or historical (imported history).

Available options:
note,
comms,
financial,
appt,
membership,
system,
historical
data
string
required

The entry's text content, as shown on the Activity Log tab.

sub_type
string | null

Free-text refinement of type — your own label, not validated against a list.

Maximum string length: 255
source_entity
string | null

Free-text label for what generated the entry, when type alone isn't specific enough.

Maximum string length: 255
metadata
object

Integrator-owned key/value metadata (max 50 keys). Values are strings (≤500 chars), numbers or booleans and read back with the type they were written with. On write, a null value removes the key. Filter with metadata[key]=op:value; number operands compare numerically.

Response

The resource

data
object
Example: