Create Appointment

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 '
{
  "slot_id": "<string>",
  "client_id": 123,
  "client_remote_id": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "phone": "<string>",
  "email": "<string>",
  "patient_id": 123,
  "patient_remote_id": "<string>",
  "note": "<string>"
}
'

import requests

url = "https://partner-api.getoliver.com/services/core/open_api/v1/appointments"

payload = {
    "slot_id": "<string>",
    "client_id": 123,
    "client_remote_id": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "patient_id": 123,
    "patient_remote_id": "<string>",
    "note": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    slot_id: '<string>',
    client_id: 123,
    client_remote_id: '<string>',
    first_name: '<string>',
    last_name: '<string>',
    phone: '<string>',
    email: '<string>',
    patient_id: 123,
    patient_remote_id: '<string>',
    note: '<string>'
  })
};

fetch('https://partner-api.getoliver.com/services/core/open_api/v1/appointments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://partner-api.getoliver.com/services/core/open_api/v1/appointments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'slot_id' => '<string>',
    'client_id' => 123,
    'client_remote_id' => '<string>',
    'first_name' => '<string>',
    'last_name' => '<string>',
    'phone' => '<string>',
    'email' => '<string>',
    'patient_id' => 123,
    'patient_remote_id' => '<string>',
    'note' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://partner-api.getoliver.com/services/core/open_api/v1/appointments"

	payload := strings.NewReader("{\n  \"slot_id\": \"<string>\",\n  \"client_id\": 123,\n  \"client_remote_id\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"email\": \"<string>\",\n  \"patient_id\": 123,\n  \"patient_remote_id\": \"<string>\",\n  \"note\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://partner-api.getoliver.com/services/core/open_api/v1/appointments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"slot_id\": \"<string>\",\n  \"client_id\": 123,\n  \"client_remote_id\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"email\": \"<string>\",\n  \"patient_id\": 123,\n  \"patient_remote_id\": \"<string>\",\n  \"note\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://partner-api.getoliver.com/services/core/open_api/v1/appointments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"slot_id\": \"<string>\",\n  \"client_id\": 123,\n  \"client_remote_id\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"email\": \"<string>\",\n  \"patient_id\": 123,\n  \"patient_remote_id\": \"<string>\",\n  \"note\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "id": 123,
    "remote_id": "<string>",
    "remote_client_id": "<string>",
    "remote_patient_id": "<string>",
    "booking_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "referral_source": "<string>",
    "referral_campaign": "<string>",
    "referral_medium": "<string>",
    "client_first_name": "<string>",
    "client_last_name": "<string>",
    "client_email": "<string>",
    "client_phone": "<string>",
    "client_type": "<string>",
    "patient_name": "<string>"
  },
  "message": "<string>"
}

{
  "success": true,
  "message": "<string>",
  "data": {}
}

{
  "success": true,
  "message": "<string>",
  "data": {}
}

{
  "success": true,
  "message": "<string>",
  "data": {}
}

POST

services

core

open_api

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 '
{
  "slot_id": "<string>",
  "client_id": 123,
  "client_remote_id": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "phone": "<string>",
  "email": "<string>",
  "patient_id": 123,
  "patient_remote_id": "<string>",
  "note": "<string>"
}
'

import requests

url = "https://partner-api.getoliver.com/services/core/open_api/v1/appointments"

payload = {
    "slot_id": "<string>",
    "client_id": 123,
    "client_remote_id": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "patient_id": 123,
    "patient_remote_id": "<string>",
    "note": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    slot_id: '<string>',
    client_id: 123,
    client_remote_id: '<string>',
    first_name: '<string>',
    last_name: '<string>',
    phone: '<string>',
    email: '<string>',
    patient_id: 123,
    patient_remote_id: '<string>',
    note: '<string>'
  })
};

fetch('https://partner-api.getoliver.com/services/core/open_api/v1/appointments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://partner-api.getoliver.com/services/core/open_api/v1/appointments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'slot_id' => '<string>',
    'client_id' => 123,
    'client_remote_id' => '<string>',
    'first_name' => '<string>',
    'last_name' => '<string>',
    'phone' => '<string>',
    'email' => '<string>',
    'patient_id' => 123,
    'patient_remote_id' => '<string>',
    'note' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://partner-api.getoliver.com/services/core/open_api/v1/appointments"

	payload := strings.NewReader("{\n  \"slot_id\": \"<string>\",\n  \"client_id\": 123,\n  \"client_remote_id\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"email\": \"<string>\",\n  \"patient_id\": 123,\n  \"patient_remote_id\": \"<string>\",\n  \"note\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://partner-api.getoliver.com/services/core/open_api/v1/appointments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"slot_id\": \"<string>\",\n  \"client_id\": 123,\n  \"client_remote_id\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"email\": \"<string>\",\n  \"patient_id\": 123,\n  \"patient_remote_id\": \"<string>\",\n  \"note\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://partner-api.getoliver.com/services/core/open_api/v1/appointments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"slot_id\": \"<string>\",\n  \"client_id\": 123,\n  \"client_remote_id\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"email\": \"<string>\",\n  \"patient_id\": 123,\n  \"patient_remote_id\": \"<string>\",\n  \"note\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "id": 123,
    "remote_id": "<string>",
    "remote_client_id": "<string>",
    "remote_patient_id": "<string>",
    "booking_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "referral_source": "<string>",
    "referral_campaign": "<string>",
    "referral_medium": "<string>",
    "client_first_name": "<string>",
    "client_last_name": "<string>",
    "client_email": "<string>",
    "client_phone": "<string>",
    "client_type": "<string>",
    "patient_name": "<string>"
  },
  "message": "<string>"
}

{
  "success": true,
  "message": "<string>",
  "data": {}
}

{
  "success": true,
  "message": "<string>",
  "data": {}
}

{
  "success": true,
  "message": "<string>",
  "data": {}
}

Create an appointment using a time slot from the Search Open Times endpoint.

Workflow

Call Search Open Times to get available slots
Use the uuid from a result as the slot_id in this request
Identify the client and patient using one of the supported lookup methods

Client Identification

Provide one of the following to identify the client:

client_id — internal Oliver ID
client_remote_id — PIMS remote ID
first_name + last_name + (phone or email) — name-based lookup

Patient Identification

Provide one of the following to identify the patient:

patient_id — internal Oliver ID
patient_remote_id — PIMS remote ID

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

slot_id

string

required

The slot identifier returned from the Search Open Times endpoint (the uuid field). Encodes the appointment type, provider, room, and time.

client_id

integer

The internal Oliver ID of the client. Provide this, client_remote_id, or name + contact fields.

client_remote_id

string

The PIMS remote ID of the client. Alternative to client_id.

first_name

string

Client first name. Must be combined with last_name and either phone or email.

last_name

string

Client last name. Must be combined with first_name and either phone or email.

phone

string

Client phone number. Used with first_name + last_name to look up the client.

string

Client email. Used with first_name + last_name to look up the client.

patient_id

integer

The internal Oliver ID of the patient. Provide this or patient_remote_id.

patient_remote_id

string

The PIMS remote ID of the patient. Alternative to patient_id.

note

string

A note for the appointment.

status

enum<string>

Appointment status override. If omitted, the clinic's auto-accept setting determines the status.

Available options:

REQUESTED,

ACCEPTED,

CONFIRMED

Response

Appointment created

success

boolean

required

data

object

required

Show child attributes

message

string

A human-readable message, e.g. 'Appointment created successfully'

API Documentation

Authentication

Open Times Endpoints

Appointments Endpoints

Clients Endpoints

Patients Endpoints

Booking Sessions Endpoints

Staff Tasks Endpoints

AI Outbound Endpoints

Phone Calls Endpoints

Webhooks

Workflow

Client Identification

Patient Identification

Authorizations

Body

Response

​Workflow

​Client Identification

​Patient Identification

Authorizations

Body

Response

Workflow

Client Identification

Patient Identification