API Reference

Create an Appointment

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

Schedules a new appointment for a patient. Requires specifying the service, schedule, reservation time, and the patient (relatedToLead).

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

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

string
required

The unique identifier of the service being booked. This ID specifies the type of appointment.

string
required

The unique identifier of the provider's schedule that the appointment is being booked within.

status
object
required

Object containing the initial status of the appointment.

date-time
required

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

relatedToLead
object
required

Object containing the patient's unique identifier to link the appointment.

string

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

string

The unique identifier of the CRM user who is creating the appointment.

Headers
string
required

Your unique Organization ID.

Response

Updated 9 months ago

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

Updated 9 months ago

Did this page help you?