Skip to navigation
API ReferenceNotesNote Attachments

Upload note attachment

Attach one file to a note. Send multipart/form-data with the file in the file field (max 20 MB). Allowed extensions: csv, doc, docx, eml, gif, jpeg, jpg, msg, pdf, png, txt, webp, xls, xlsx. The note must be linked to a participant or provider. The note’s count_attachments is updated.

Authentication

AuthorizationBearer
API key issued for your account. Send as Bearer token in the Authorization header.
X-Plan-Manager-Idstring
Plan manager UUID. Required on all public API requests to scope data access.

Path parameters

note_idstringRequired

Note id (bigint as string)

Request

This endpoint expects a multipart form containing a file.
filefileRequired
File to attach

Response

Attachment uploaded
idstringformat: "uuid"
Attachment id
note_idstring

Note id (bigint as string)

file_namestring

Stored file name (timestamp prefix plus sanitised original name)

sizeinteger or nullOptional
File size in bytes
content_typestring or nullOptional
MIME type
created_atdatetime or nullOptional

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
413
Content Too Large Error
500
Internal Server Error