Skip to main content
POST
Apply Attachment Annotation Diff

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

attachment_id
string
required

Body

application/json

Per-mark diff applied to an attachment's annotations in one request.

created and updated are raw annotation dicts (the server stamps audit fields). deleted_ids is the set of annotation ids to remove. Missing targets for updated/deleted_ids are treated as a no-op (a concurrent writer already removed them); collisions in created raise 409.

created
Created · object[]
updated
Updated · object[]
deletedIds
string[]

Response

Successful Response

id
string
required
gcsPath
string
required
originalFilename
string
required
signedUrl
string
required
name
string
required
createdDate
string<date-time>
required
noteId
string | null
thumbnailSignedUrl
string | null
annotations
Annotations · object[] | null
patient
PatientSummary · object | null
note
NoteAttachmentNote · object | null
provider
ProviderTiny · object | null
tags
NoteAttachmentTagSummary · object[]
visibleToPatient
boolean
default:false
patientCaption
string | null