API Reference

Create a New Appointment

post
https://emr-api.portals.care/appointments

Create a new appointment record, typically for manual booking by staff.

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

Create a new appointment record, typically for manual booking by staff. You must send the service, schedule, status, reservation, and relatedToLead parameters in the request body.

Body Params

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

string
required

The unique ID of the service being booked, e.g., 65607e4b2e1d1054bfdcc108.

string

The unique ID of the provider's schedule, e.g., 6549c8cae728bfeb023a65a9.

status
object
required

The initial status of the appointment.

date-time
required

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

relatedToLead
object
required

The patient (patient) the appointment is for.

string

The unique ID of the organization.

string

The unique ID of the user creating the appointment.

Response

Updated 10 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 10 months ago

Did this page help you?