Appointment

Reschedule appointment

This endpoint is used to reschedule a patient’s appointment across both TeamCare and the Practice PMS.

The workflow begins when a patient contacts the dental office to request an appointment reschedule. First, the patient’s information is retrieved using the patients/search API. It is required to identify and match the patient within the TeamCare database, as the corresponding patient ID will be used in subsequent steps. Patient found from patient search api call should be of type Patient and not Patient Request. If patient found in Patient Request or not found at all it means patient is new and it don’t have any appointment already scheduled.

Next, the appointments/search API is used to locate the patient’s upcoming appointments. From the response, the relevant appointment ID is obtained. This appointment ID is then passed as a URL parameter to the rescheduling endpoint.

The appointment is rescheduled by providing a new appointment_at value in UTC format. TeamCare will automatically handle timezone conversion based on the associated practice settings, ensuring the correct local time is applied.

Ai Agent will just have to hit on reschedule end point as above to reschedule the appointment.
Organization id in url will be the id for practice in teamcare database.
Response
Content-Type: application/json
Data attribute returned just to give you insights, it has nothing to do with patient.

POST

organizations

{organization_id}

appointments

{appointment_id}

reschedule

Reschedule appointment

curl --request POST \
  --url https://app.teamcaredental.com/api/v1/ai_voice/organizations/{organization_id}/appointments/{appointment_id}/reschedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "appointment": {
    "appointment_at": "2028-07-11T11:00:00Z"
  }
}
'

import requests

url = "https://app.teamcaredental.com/api/v1/ai_voice/organizations/{organization_id}/appointments/{appointment_id}/reschedule"

payload = { "appointment": { "appointment_at": "2028-07-11T11:00:00Z" } }
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({appointment: {appointment_at: '2028-07-11T11:00:00Z'}})
};

fetch('https://app.teamcaredental.com/api/v1/ai_voice/organizations/{organization_id}/appointments/{appointment_id}/reschedule', 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://app.teamcaredental.com/api/v1/ai_voice/organizations/{organization_id}/appointments/{appointment_id}/reschedule",
  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([
    'appointment' => [
        'appointment_at' => '2028-07-11T11:00:00Z'
    ]
  ]),
  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://app.teamcaredental.com/api/v1/ai_voice/organizations/{organization_id}/appointments/{appointment_id}/reschedule"

	payload := strings.NewReader("{\n  \"appointment\": {\n    \"appointment_at\": \"2028-07-11T11:00:00Z\"\n  }\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://app.teamcaredental.com/api/v1/ai_voice/organizations/{organization_id}/appointments/{appointment_id}/reschedule")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"appointment\": {\n    \"appointment_at\": \"2028-07-11T11:00:00Z\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.teamcaredental.com/api/v1/ai_voice/organizations/{organization_id}/appointments/{appointment_id}/reschedule")

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  \"appointment\": {\n    \"appointment_at\": \"2028-07-11T11:00:00Z\"\n  }\n}"

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

{}

{
  "errors": "not authorized"
}

{
  "errors": "access Denied"
}

{
  "error": "Appointment not found"
}

{
  "errors": "..."
}

Authorizations

Authorization

string

header

required

JWT returned by POST /auth/token. Valid for six hours.

Path Parameters

organization_id

string

required

appointment_id

string

required

Body

application/json

appointment

object

Show child attributes

Response

Successful response

The response is of type object.

⌘I

Reschedule appointment

curl --request POST \
  --url https://app.teamcaredental.com/api/v1/ai_voice/organizations/{organization_id}/appointments/{appointment_id}/reschedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "appointment": {
    "appointment_at": "2028-07-11T11:00:00Z"
  }
}
'

import requests

url = "https://app.teamcaredental.com/api/v1/ai_voice/organizations/{organization_id}/appointments/{appointment_id}/reschedule"

payload = { "appointment": { "appointment_at": "2028-07-11T11:00:00Z" } }
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({appointment: {appointment_at: '2028-07-11T11:00:00Z'}})
};

fetch('https://app.teamcaredental.com/api/v1/ai_voice/organizations/{organization_id}/appointments/{appointment_id}/reschedule', 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://app.teamcaredental.com/api/v1/ai_voice/organizations/{organization_id}/appointments/{appointment_id}/reschedule",
  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([
    'appointment' => [
        'appointment_at' => '2028-07-11T11:00:00Z'
    ]
  ]),
  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://app.teamcaredental.com/api/v1/ai_voice/organizations/{organization_id}/appointments/{appointment_id}/reschedule"

	payload := strings.NewReader("{\n  \"appointment\": {\n    \"appointment_at\": \"2028-07-11T11:00:00Z\"\n  }\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://app.teamcaredental.com/api/v1/ai_voice/organizations/{organization_id}/appointments/{appointment_id}/reschedule")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"appointment\": {\n    \"appointment_at\": \"2028-07-11T11:00:00Z\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.teamcaredental.com/api/v1/ai_voice/organizations/{organization_id}/appointments/{appointment_id}/reschedule")

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  \"appointment\": {\n    \"appointment_at\": \"2028-07-11T11:00:00Z\"\n  }\n}"

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

{}

{
  "errors": "not authorized"
}

{
  "errors": "access Denied"
}

{
  "error": "Appointment not found"
}

{
  "errors": "..."
}