Skip to main content
PATCH
/
dr
/
v1
/
appointment
/
{appointment_id}
Update Appointment
curl --request PATCH \
  --url https://api.eka.care/dr/v1/appointment/{appointment_id} \
  --header 'Content-Type: application/json' \
  --header 'auth: <auth>' \
  --data '
{
  "custom_attributes": {
    "label": [
      "vital_submitted"
    ],
    "tags": [
      "in_consult",
      "paid"
    ]
  },
  "partner_meta": {},
  "patient_details": {
    "designation": "Mr.",
    "first_name": "Test",
    "middle_name": "",
    "last_name": "Patient",
    "mobile": "+919999999999",
    "gender": "M",
    "dob": "1987-01-06",
    "address": {
      "city": "Bangalore",
      "pincode": 560049
    },
    "partner_patient_id": "6742984"
  },
  "token": 2,
  "video_connect": {
    "vendor": "100ms",
    "url": "https://xyz.live/meeting/nfo-necy-cwg",
    "pt_joined": 1747311346
  },
  "display_meta": {
    "key1": "value1"
  }
}
'
{
  "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
​
custom_attributes
object
​
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.

​
start_time
integer

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

​
end_time
integer

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

​
token
integer

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

​
video_connect
object
​
patient_details
DOB · object
  • DOB
  • AGE
​
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

OK