v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB

Appointment API

Update Appointment

Overview

This API endpoint is used to update an existing appointment.

patch/dr/v1/appointment/{appointment_id}

Path parameters

appointment_idstring required

Query parameters

partner_idstring

Example:1

If set to 1 then appointment_id in path parameter should be partner_appointment_id else eka apppointment_id

Headers

authstring required

Example:auth

Request body

custom_attributesobject

partner_metaobject

This field is a set of key-value pair very specific to our partner and not visible in appointment queue. These key-value pairs are just stored at our end and echoed back in appointment related apis. We dont use it for any computation. In case of update it will be completely overridden.

start_timeinteger

Start time of new appointment in epoch. To be used in order to reschedule appointment.

end_timeinteger

End time of new appointment in epoch. To be used in order to reschedule appointment.

tokeninteger

A unique number given to each patient to indicate their position in the queue.

display_metaobject

This field is a set of key-value pair.
The value corresponding to a key must be string, int, or float.
Keys in display_meta must not exceed 30 characters.
The value for a key must not exceed 50 characters.
These key-value pairs will be shown on the appointment card.
For key names, it is recommended to use underscores (_) instead of spaces. During display, underscores will be replaced with spaces, and the following letter will be capitalized automatically.
Example:
"vendor_patient_id": "P41025551968206" will be shown as "Vendor Patient Id": "P41025551968206"

Example request

{
  "video_connect": {
    "vendor": "100ms",
    "url": "https://xyz.com/landing",
    "pt_joined": 1747311346
  },
  "patient_details": {
    "designation": "Mr.",
    "first_name": "Test",
    "partner_patient_id": "6742984",
    "last_name": "Patient",
    "mobile": "+919999999999",
    "gender": "M",
    "address": {
      "city": "Bangalore",
      "pincode": 560049
    },
    "dob": "1987-01-06"
  }
}

v1