Upload Single File

put

https://patient-api.portals.care/files/single

Upload a single file and receive upload metadata.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

To upload or update a single file for the patient, you can use this endpoint with a PUT request. You will need to authenticate by providing the user's JWT in the Authorization header. Optionally, provide the unique organization ID in the request header. In the request body, you must provide the file's name, encoding, and buffer.

Body Params

A schema representing a file, typically for an uploaded document or image within the patient portal.

name

string

required

The name assigned to the file by the system.

originalName

string

The original name of the file as it was uploaded by the patient.

encoding

string

required

The file's encoding type.

mimetype

string

The MIME type of the file, indicating its format.

size

number

The size of the file in bytes.

loaded

boolean

A boolean indicating whether the file's data has been fully loaded into the system.

createdAt

date-time

The timestamp when the file was created in ISO 8601 format.

updatedAt

date-time

The timestamp when the file was last updated in ISO 8601 format.

Headers

authorization

string

required

A Valid JWT Authentication token.

organization

string

Your unique Organization ID. This header is only required when using a custom portal domain, otherwise it is optional.

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200