Update Document¶

Partially update an existing document record. Send only the fields that need to change; omitted fields retain their current values.

Endpoint¶

POST /apis/v1/patient-document/{documentId}

Path Parameters¶

Parameter	Type	Required	Description
`documentId`	integer	Yes	The unique ID of the document record to update

Request Body¶

All fields are optional. Include only the ones you want to change.

Parameter	Type	Description
`name`	string	Display name for the document
`document_url`	string	URL of the stored file
`thumbnail_url`	string	URL of a thumbnail image
`document_type`	string	Free-text document type label
`document_category`	string	Category enum (see Category Values)
`spry_case_id`	string	Associate with a different case
`eligible_visit_count`	integer	Number of visits this document covers
`notes`	string	Free-text notes
`document_expiration_date`	string (datetime)	Expiration date (`YYYY-MM-DDTHH:mm:ss`)
`receipt_date`	string (datetime)	Date document was received (`YYYY-MM-DDTHH:mm:ss`)
`signature_status`	string	Signature state (see Signature Status Values)
`signed_by`	string	Name of the person who signed
`signed_at`	string (datetime)	Timestamp when the document was signed

Request¶

curl --location '{base_url}/apis/v1/patient-document/458312' \
  --header 'Authorization: Bearer JWT_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "signature_status": "COMPLETED",
    "signed_by": "Dr. Mark Stouffer",
    "signed_at": "2026-04-10T14:30:00",
    "notes": "Signed by referring physician on 2026-04-10"
  }'

Response¶

Success Response¶

Code: 200 OK

{
  "code": 2000,
  "data": {
    "id": 458312,
    "name": "PEHP Insurance Card",
    "patient_id": 1172416,
    "uploaded_by": 8821,
    "document_url": "https://storage.googleapis.com/us-phy-uploads/patients/1172416/documents/insurance-card.pdf",
    "unsigned_document_url": "https://storage.googleapis.com/us-phy-uploads/patients/1172416/documents/insurance-card.pdf",
    "thumbnail_url": null,
    "bucket_name": "us-phy-uploads",
    "document_type": "Insurance Card",
    "document_category": "INSURANCE_CARD",
    "spry_case_id": "SPRY_CASE_69cd0c97e7562d613ea89bc7",
    "case_title": "Stable Burst Fracture",
    "eligible_visit_count": 0,
    "notes": "Signed by referring physician on 2026-04-10",
    "document_expiration_date": null,
    "receipt_date": "2026-04-01T09:00:00",
    "signature_status": "COMPLETED",
    "signed_by": "Dr. Mark Stouffer",
    "signed_at": "2026-04-10T14:30:00",
    "original_file_name": "insurance-card.pdf",
    "created_at": "2026-04-01T12:00:00",
    "updated_at": "2026-04-10T14:30:00"
  },
  "message": "Success"
}

Response Fields¶

Same fields as Save Document.

Error Response¶

Code: 200 OK

{
  "code": 4004,
  "data": null,
  "message": "Document not found"
}