Update Appointment V2

curl --request PATCH \
  --url https://api.eka.care/dr/v2/appointment/{appointment_id} \
  --header 'Content-Type: application/json' \
  --header 'auth: <auth>' \
  --data '
{
  "clinic_id": "6742984",
  "doctor_id": "6742984",
  "patient_id": "6742984",
  "token": 123,
  "appointment_details": {
    "start_time": 1730189586,
    "end_time": 1730189586,
    "mode": "VIDEO",
    "custom_attributes": {},
    "video_connect": {
      "vendor": "other",
      "url": "https://meet.google.com/landing"
    }
  },
  "partner_meta": {
    "key1": "value1"
  },
  "patient_details": {
    "dob": "1987-01-06",
    "designation": "Mr.",
    "first_name": "Test",
    "partner_patient_id": "6742984",
    "middle_name": "",
    "last_name": "Patient",
    "mobile": "+919999999999",
    "gender": "M",
    "address": {
      "city": "Bangalore",
      "pincode": 560049
    }
  },
  "display_meta": {}
}
'

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The request is invalid or missing required parameters"
  }
}

PATCH

appointment

{appointment_id}

Update Appointment V2

curl --request PATCH \
  --url https://api.eka.care/dr/v2/appointment/{appointment_id} \
  --header 'Content-Type: application/json' \
  --header 'auth: <auth>' \
  --data '
{
  "clinic_id": "6742984",
  "doctor_id": "6742984",
  "patient_id": "6742984",
  "token": 123,
  "appointment_details": {
    "start_time": 1730189586,
    "end_time": 1730189586,
    "mode": "VIDEO",
    "custom_attributes": {},
    "video_connect": {
      "vendor": "other",
      "url": "https://meet.google.com/landing"
    }
  },
  "partner_meta": {
    "key1": "value1"
  },
  "patient_details": {
    "dob": "1987-01-06",
    "designation": "Mr.",
    "first_name": "Test",
    "partner_patient_id": "6742984",
    "middle_name": "",
    "last_name": "Patient",
    "mobile": "+919999999999",
    "gender": "M",
    "address": {
      "city": "Bangalore",
      "pincode": 560049
    }
  },
  "display_meta": {}
}
'

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The request is invalid or missing required parameters"
  }
}

Headers

auth

string

required

Example:

"auth"

Path Parameters

appointment_id

string

required

Query Parameters

partner_id

string

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

Example:

"1"

Body

application/json

EkaIds
PartnerIds

clinic_id

string

required

Identifier for the clinic in Eka.

Example:

"6742984"

doctor_id

string

required

Identifier for the doctor in Eka.

Example:

"6742984"

patient_id

string

required

Identifier for the patient in Eka.

Example:

"6742984"

token

integer

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

appointment_details

object

Show child attributes

appointment_details.start_time

integer

Start time of the appointment in epoch

Example:

1730189586

appointment_details.end_time

integer

End time of the appointment in epoch

Example:

1730189586

appointment_details.mode

enum<string>

Available options:

INCLINIC,

PHONE,

VIDEO

Example:

"VIDEO"

appointment_details.custom_attributes

object

Custom attributes and value for each custom attribute are a fixed set of enum defined by our partner at the time of onboarding. Labels and Tags are special type of custom attributes which exist by default for every partner and are visible in appointment queue. key-value pair within labels and tags can be defined by each repective partner. Position of other custom attributes in appointment queue need to configured by partner.

appointment_details.video_connect

object

Configuration of video connect. To be used only when mode is VIDEO

Show child attributes

appointment_details.video_connect.vendor

enum<string>

Available options:

other

appointment_details.video_connect.url

string

Example:

"https://meet.google.com/landing"

partner_meta

object

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.

Show child attributes

partner_meta.key1

string

Example:

"value1"

patient_details

DOB · object

Show child attributes

patient_details.dob

string<date>

required

Date of birth of the patient (YYYY-MM-DD)

Example:

"1987-01-06"

patient_details.designation

enum<string>

Title or designation of the patient

Available options:

Mr.,

Ms.,

Mrs.,

Miss.,

Kumar.,

Shri.,

Smt.,

Dr.,

Master.,

Baby.,

Mohd.,

B/O

Example:

"Mr."

patient_details.first_name

string

First name of the patient

Example:

"Test"

patient_details.partner_patient_id

string

Identifier for the partner’s patient.

Example:

"6742984"

patient_details.middle_name

string

Middle name of the patient (if any)

Example:

""

patient_details.last_name

string

Last name of the patient

Example:

"Patient"

patient_details.mobile

string

Mobile number of the patient, including country code

Example:

"+919999999999"

patient_details.gender

enum<string>

Gender of the patient (e.g., 'M' for male, 'F' for female, 'O' for others)

Available options:

M,

F,

O

Example:

"M"

patient_details.address

object

Address details of the patient

Show child attributes

patient_details.address.city

string

Example:

"Bangalore"

patient_details.address.pincode

integer

Example:

560049

display_meta

object

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"

Response

Update Appointment Parked Appointment

⌘I

Authorization

End-to-End Encryption

Connect

HealthAI

Medical Database

General Tools

Doctor Tool

ABDM Connect

Medical Knowledge-bases

Medical Records

User App

Update Appointment V2

Overview

Headers

Path Parameters

Query Parameters

Body

Response