Skip to main content
POST
/
services
/
core
/
open_api
/
v1
/
appointments
cURL
curl --request POST \
  --url https://partner-api.getoliver.com/services/core/open_api/v1/appointments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "date": "2023-12-25",
  "end_date": "2023-12-25",
  "provider_id": "<string>",
  "appointment_type_id": "<string>",
  "patient_id": "<string>",
  "client_id": "<string>",
  "note": "<string>",
  "room_id": "<string>",
  "referral_source": "<string>"
}
'
{
  "success": true,
  "data": {
    "id": "<string>"
  },
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Appointment to create

​
date
string<date>
required

The start date/time of the appointment in ISO 8601 format

​
end_date
string<date>
required

The end date/time of the appointment in ISO 8601 format

​
provider_id
string
required

The ID of the provider that this appointment is for

​
appointment_type_id
string
required

The ID of the appointment type that this appointment is for

​
patient_id
string
required

The ID of the patient that this appointment is for

​
client_id
string
required

The ID of the client that this appointment is for

​
note
string

A note for the appointment

​
room_id
string

The ID of the room that this appointment is for

​
referral_source
string

The partner's referral source for this appointment. e.g. 'Google', 'Facebook', 'Website', etc.

Response

Appointment created

​
success
boolean
required
​
data
object
required
​
message
string