API Reference

Update a Consultation

put
https://patient-api.portals.care/consultations/

Update fields on an existing consultation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Update a specific consultation. Provide the consultation id in the path and authenticate by providing the user's JWT in the Authorization.

In the request body, provide the updated consultation data.

Path Params
string
required

The ID of the consultation to update.

Body Params

A Data Transfer Object (DTO) for updating an existing patient consultation. This is used to submit new answers, change the consultation status, or update related metadata.

string
enum

The type of consultation or questionnaire being updated.

Allowed:
status
object

The updated status of the consultation.

string

The two-letter code for the patient's province or state.

string

The unique identifier of the order that this consultation is linked to, if applicable.

Headers
string
required

A Valid JWT Authentication token.

string

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

Response

Updated 7 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago

Did this page help you?