Create an Appointment

post

https://patient-api.portals.care/appointments

Create a new appointment for the patient.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Create a new appointment for the patient. Authenticate by providing the patient's JWT in the Authorization header.

In the request body, you must provide the following parameters:

service
status
reservation
relatedToLead

Body Params

A Data Transfer Object (DTO) for creating a new patient appointment.

service

string

The unique identifier of the service being booked. This ID specifies the type of appointment, such as a consultation or a physical therapy session.

schedule

string

The unique identifier of the provider's schedule that the appointment is being booked within. This links the appointment to a specific provider and their available time slots.

status

object

Object containing the Status of the appointment.

reservation

date-time

The scheduled date and time of the appointment in ISO 8601 format.

relatedToLead

object

The patient's unique identifier. This links the appointment to the specific patient who created it.

organization

string

The unique identifier for the organization or clinic associated with the appointment.

createdBy

string

The unique identifier of the user who created the appointment. In this context, it is the patient's ID.

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

201

Language

Loading…

Response

Click Try It! to start a request and see the response here!