Update participant document

Update document metadata. Only fields sent are changed; send plan_id as null to unlink the plan. The file itself cannot be replaced.

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

participant_idstringRequiredformat: "uuid"

Participant UUID

document_idstringRequired

Document id (bigint as string)

Request

This endpoint expects an object.

document_namestringOptional>=1 character

document_typestringOptional

portal_accessbooleanOptional

plan_idinteger or nullOptional

NDIS plan id to link (must belong to this participant); null to unlink

external_idstringOptional

Response

Updated document

idstring

Document id (bigint as string)

created_atdatetimeOptional

participantstringOptionalformat: "uuid"

document_namestringOptional

document_typestringOptional

portal_accessbooleanOptional

Whether the participant can see it in the portal

plan_idinteger or nullOptional

Linked NDIS plan id

external_idstring or nullOptional

file_system_typeenumOptional

Where the file is stored. Only legacy documents can be downloaded through the API.

Allowed values:

portal_document_statusenum or nullOptional

Set for documents the participant uploaded through the portal (read-only)

Allowed values:

uploaded_bystring or nullOptional

Portal uploader (read-only)

rejection_reasonstring or nullOptional

Why a portal upload was rejected (read-only)

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error