Remove a document
Delete one document from a patient's file.
DELETE /v1/patients/{patientId}/documents/{documentId}Answers 200. Like every write here it is attributed to the acting user.
API-key only (a widget session is refused), entitlement-gated on devapi_patients_documents_delete, and attributed with X-Acting-User-Id.
Path parameters
| Name | Required | Description |
|---|---|---|
patientId | Yes | Fills the :patientId segment. |
documentId | Yes | — |
Try it
/v1/patients/:patientId/documents/:documentIdAPI key onlydevapi_patients_documents_deletePath
DELETE /v1/patients//documents/https://api.medos.oneUse a dedicated test key, and put your browser's address on its allowlist
A Developer API key authenticates on its own, so it only works from the addresses registered against it — and this page calls from your browser, not your servers. Unless your own public address is on the list you get a 403 naming it, which is the allowlist doing its job. Your browser may also reach us over IPv6 even when your server does not, so the address in the error is often not the one you expected. The key here is kept in memory only and never written to storage, but create a test key for it and deactivate that key when you are done.
Request
curl -s -X DELETE "https://api.medos.one/v1/patients/1/documents/31" \
-H "x-api-key: $MEDOS_API_KEY" \
-H "X-Acting-User-Id: 4821"Common failures
| Status | Cause |
|---|---|
400 naming x-acting-user-id | A write without the acting-user header. |
403 with requiredFeature | Not entitled to this operation. |
403 "only available to Developer API keys" | A widget session token was used. Send x-api-key. |
403 "not an active member" | The acting user is not in your workspace, or is deactivated. |