API Reference

Create Appointment

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

Books a new appointment for a patient with optional validation.

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

To book a new appointment, you can use this endpoint with a POST request. The request body must contain appointment details, such as the service_id and the selected time slot.

Body Params
string
required

The ID of the service to book.

string

The ID of the provider's schedule to book.

string
required

The desired reservation date and time.

hc
object
stripeToken
object

The Stripe payment token.

string
string
boolean

If true, the request is only validated and no appointment is created.

boolean
number
number
string
meta
object
Headers
string

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

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?