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"
}
}
'import requests
url = "https://api.eka.care/dr/v1/appointment/{appointment_id}"
payload = {
"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" }
}
headers = {
"auth": "<auth>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {auth: '<auth>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'}
})
};
fetch('https://api.eka.care/dr/v1/appointment/{appointment_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.patch("https://api.eka.care/dr/v1/appointment/{appointment_id}")
.header("auth", "<auth>")
.header("Content-Type", "application/json")
.body("{\n \"custom_attributes\": {\n \"label\": [\n \"vital_submitted\"\n ],\n \"tags\": [\n \"in_consult\",\n \"paid\"\n ]\n },\n \"partner_meta\": {},\n \"patient_details\": {\n \"designation\": \"Mr.\",\n \"first_name\": \"Test\",\n \"middle_name\": \"\",\n \"last_name\": \"Patient\",\n \"mobile\": \"+919999999999\",\n \"gender\": \"M\",\n \"dob\": \"1987-01-06\",\n \"address\": {\n \"city\": \"Bangalore\",\n \"pincode\": 560049\n },\n \"partner_patient_id\": \"6742984\"\n },\n \"token\": 2,\n \"video_connect\": {\n \"vendor\": \"100ms\",\n \"url\": \"https://xyz.live/meeting/nfo-necy-cwg\",\n \"pt_joined\": 1747311346\n },\n \"display_meta\": {\n \"key1\": \"value1\"\n }\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.eka.care/dr/v1/appointment/{appointment_id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("auth", "<auth>");
request.AddJsonBody("{\n \"custom_attributes\": {\n \"label\": [\n \"vital_submitted\"\n ],\n \"tags\": [\n \"in_consult\",\n \"paid\"\n ]\n },\n \"partner_meta\": {},\n \"patient_details\": {\n \"designation\": \"Mr.\",\n \"first_name\": \"Test\",\n \"middle_name\": \"\",\n \"last_name\": \"Patient\",\n \"mobile\": \"+919999999999\",\n \"gender\": \"M\",\n \"dob\": \"1987-01-06\",\n \"address\": {\n \"city\": \"Bangalore\",\n \"pincode\": 560049\n },\n \"partner_patient_id\": \"6742984\"\n },\n \"token\": 2,\n \"video_connect\": {\n \"vendor\": \"100ms\",\n \"url\": \"https://xyz.live/meeting/nfo-necy-cwg\",\n \"pt_joined\": 1747311346\n },\n \"display_meta\": {\n \"key1\": \"value1\"\n }\n}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
require 'uri'
require 'net/http'
url = URI("https://api.eka.care/dr/v1/appointment/{appointment_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["auth"] = '<auth>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"custom_attributes\": {\n \"label\": [\n \"vital_submitted\"\n ],\n \"tags\": [\n \"in_consult\",\n \"paid\"\n ]\n },\n \"partner_meta\": {},\n \"patient_details\": {\n \"designation\": \"Mr.\",\n \"first_name\": \"Test\",\n \"middle_name\": \"\",\n \"last_name\": \"Patient\",\n \"mobile\": \"+919999999999\",\n \"gender\": \"M\",\n \"dob\": \"1987-01-06\",\n \"address\": {\n \"city\": \"Bangalore\",\n \"pincode\": 560049\n },\n \"partner_patient_id\": \"6742984\"\n },\n \"token\": 2,\n \"video_connect\": {\n \"vendor\": \"100ms\",\n \"url\": \"https://xyz.live/meeting/nfo-necy-cwg\",\n \"pt_joined\": 1747311346\n },\n \"display_meta\": {\n \"key1\": \"value1\"\n }\n}"
response = http.request(request)
puts response.read_body{
"error": {
"code": "INVALID_REQUEST",
"message": "The request is invalid or missing required parameters"
}
}{
"error": {
"code": "APPOINTMENT_NOT_FOUND",
"message": "The specified appointment ID does not exist"
}
}{
"error": {
"code": "SERVER_ERROR",
"message": "An unexpected error occurred on the server"
}
}Appointment API
Update Appointment
Overview
This API endpoint is used to update an existing appointment.
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"
}
}
'import requests
url = "https://api.eka.care/dr/v1/appointment/{appointment_id}"
payload = {
"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" }
}
headers = {
"auth": "<auth>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {auth: '<auth>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'}
})
};
fetch('https://api.eka.care/dr/v1/appointment/{appointment_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.patch("https://api.eka.care/dr/v1/appointment/{appointment_id}")
.header("auth", "<auth>")
.header("Content-Type", "application/json")
.body("{\n \"custom_attributes\": {\n \"label\": [\n \"vital_submitted\"\n ],\n \"tags\": [\n \"in_consult\",\n \"paid\"\n ]\n },\n \"partner_meta\": {},\n \"patient_details\": {\n \"designation\": \"Mr.\",\n \"first_name\": \"Test\",\n \"middle_name\": \"\",\n \"last_name\": \"Patient\",\n \"mobile\": \"+919999999999\",\n \"gender\": \"M\",\n \"dob\": \"1987-01-06\",\n \"address\": {\n \"city\": \"Bangalore\",\n \"pincode\": 560049\n },\n \"partner_patient_id\": \"6742984\"\n },\n \"token\": 2,\n \"video_connect\": {\n \"vendor\": \"100ms\",\n \"url\": \"https://xyz.live/meeting/nfo-necy-cwg\",\n \"pt_joined\": 1747311346\n },\n \"display_meta\": {\n \"key1\": \"value1\"\n }\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.eka.care/dr/v1/appointment/{appointment_id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("auth", "<auth>");
request.AddJsonBody("{\n \"custom_attributes\": {\n \"label\": [\n \"vital_submitted\"\n ],\n \"tags\": [\n \"in_consult\",\n \"paid\"\n ]\n },\n \"partner_meta\": {},\n \"patient_details\": {\n \"designation\": \"Mr.\",\n \"first_name\": \"Test\",\n \"middle_name\": \"\",\n \"last_name\": \"Patient\",\n \"mobile\": \"+919999999999\",\n \"gender\": \"M\",\n \"dob\": \"1987-01-06\",\n \"address\": {\n \"city\": \"Bangalore\",\n \"pincode\": 560049\n },\n \"partner_patient_id\": \"6742984\"\n },\n \"token\": 2,\n \"video_connect\": {\n \"vendor\": \"100ms\",\n \"url\": \"https://xyz.live/meeting/nfo-necy-cwg\",\n \"pt_joined\": 1747311346\n },\n \"display_meta\": {\n \"key1\": \"value1\"\n }\n}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
require 'uri'
require 'net/http'
url = URI("https://api.eka.care/dr/v1/appointment/{appointment_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["auth"] = '<auth>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"custom_attributes\": {\n \"label\": [\n \"vital_submitted\"\n ],\n \"tags\": [\n \"in_consult\",\n \"paid\"\n ]\n },\n \"partner_meta\": {},\n \"patient_details\": {\n \"designation\": \"Mr.\",\n \"first_name\": \"Test\",\n \"middle_name\": \"\",\n \"last_name\": \"Patient\",\n \"mobile\": \"+919999999999\",\n \"gender\": \"M\",\n \"dob\": \"1987-01-06\",\n \"address\": {\n \"city\": \"Bangalore\",\n \"pincode\": 560049\n },\n \"partner_patient_id\": \"6742984\"\n },\n \"token\": 2,\n \"video_connect\": {\n \"vendor\": \"100ms\",\n \"url\": \"https://xyz.live/meeting/nfo-necy-cwg\",\n \"pt_joined\": 1747311346\n },\n \"display_meta\": {\n \"key1\": \"value1\"\n }\n}"
response = http.request(request)
puts response.read_body{
"error": {
"code": "INVALID_REQUEST",
"message": "The request is invalid or missing required parameters"
}
}{
"error": {
"code": "APPOINTMENT_NOT_FOUND",
"message": "The specified appointment ID does not exist"
}
}{
"error": {
"code": "SERVER_ERROR",
"message": "An unexpected error occurred on the server"
}
}Query Parameters
Body
application/json
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.
- This field is a set of
key-value pair. - The value corresponding to a key must be string, int, or float.
- Keys in
display_metamust 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
Was this page helpful?

