Update Schedule
curl --request PATCH \
--url https://api.eka.care/schedule/{scheduleId} \
--header 'Content-Type: application/json' \
--header 'auth: <auth>' \
--data '
{
"config": {
"overbooking_limit": 3
},
"timebounds": {
"daily": {
"2026-10-16": {
"booking_id": "bk_9f31c2",
"is_enabled": true,
"bounds": [
{
"s": 1000,
"e": 1300,
"conf_ids": [
"conf_abc123"
]
}
]
}
}
},
"deleteTimebounds": {
"block": [
"bk_5a01e7"
]
}
}
'import requests
url = "https://api.eka.care/schedule/{scheduleId}"
payload = {
"config": { "overbooking_limit": 3 },
"timebounds": { "daily": { "2026-10-16": {
"booking_id": "bk_9f31c2",
"is_enabled": True,
"bounds": [
{
"s": 1000,
"e": 1300,
"conf_ids": ["conf_abc123"]
}
]
} } },
"deleteTimebounds": { "block": ["bk_5a01e7"] }
}
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({
config: {overbooking_limit: 3},
timebounds: {
daily: {
'2026-10-16': {
booking_id: 'bk_9f31c2',
is_enabled: true,
bounds: [{s: 1000, e: 1300, conf_ids: ['conf_abc123']}]
}
}
},
deleteTimebounds: {block: ['bk_5a01e7']}
})
};
fetch('https://api.eka.care/schedule/{scheduleId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.patch("https://api.eka.care/schedule/{scheduleId}")
.header("auth", "<auth>")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"overbooking_limit\": 3\n },\n \"timebounds\": {\n \"daily\": {\n \"2026-10-16\": {\n \"booking_id\": \"bk_9f31c2\",\n \"is_enabled\": true,\n \"bounds\": [\n {\n \"s\": 1000,\n \"e\": 1300,\n \"conf_ids\": [\n \"conf_abc123\"\n ]\n }\n ]\n }\n }\n },\n \"deleteTimebounds\": {\n \"block\": [\n \"bk_5a01e7\"\n ]\n }\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.eka.care/schedule/{scheduleId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("auth", "<auth>");
request.AddJsonBody("{\n \"config\": {\n \"overbooking_limit\": 3\n },\n \"timebounds\": {\n \"daily\": {\n \"2026-10-16\": {\n \"booking_id\": \"bk_9f31c2\",\n \"is_enabled\": true,\n \"bounds\": [\n {\n \"s\": 1000,\n \"e\": 1300,\n \"conf_ids\": [\n \"conf_abc123\"\n ]\n }\n ]\n }\n }\n },\n \"deleteTimebounds\": {\n \"block\": [\n \"bk_5a01e7\"\n ]\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/schedule/{scheduleId}")
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 \"config\": {\n \"overbooking_limit\": 3\n },\n \"timebounds\": {\n \"daily\": {\n \"2026-10-16\": {\n \"booking_id\": \"bk_9f31c2\",\n \"is_enabled\": true,\n \"bounds\": [\n {\n \"s\": 1000,\n \"e\": 1300,\n \"conf_ids\": [\n \"conf_abc123\"\n ]\n }\n ]\n }\n }\n },\n \"deleteTimebounds\": {\n \"block\": [\n \"bk_5a01e7\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"schedule_id": "<string>",
"business_id": "<string>",
"name": "<string>",
"archive": true,
"config": {
"overbooking_limit": 123,
"block_over_existing_bookings": true,
"schedule_slot_config_enabled": true,
"slot_durations": [
123
]
},
"timebounds": {},
"deleted": {},
"assignment": {
"bookable_by": [
"patient"
],
"products": [
"<string>"
],
"error": "<string>"
},
"confs_created": [
"<string>"
],
"failed_tasks": [
"<string>"
]
}
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "Unauthorised"
}{
"success": false,
"error": "schedule not found"
}{
"success": false,
"error": "<string>"
}Appointment API
Update Schedule
Overview
Edits a schedule’s name, settings (config), archive state, time windows and who can book on it, in one call. A schedule from another business returns 401. An unknown scheduleId returns 404.
- Archiving deletes the schedule’s time windows, blocks and
bookable_bygroups, the same as Delete Schedule. Unarchiving does not bring them back. - Archiving can’t be mixed with time-window or
bookable_bychanges in the same call (409). Editing an archived schedule returns409. booking_idis the id of one saved time-window row, not an appointment. The samebooking_idcan’t be in bothtimeboundsanddeleteTimebounds(400).
PATCH
/
schedule
/
{scheduleId}
Update Schedule
curl --request PATCH \
--url https://api.eka.care/schedule/{scheduleId} \
--header 'Content-Type: application/json' \
--header 'auth: <auth>' \
--data '
{
"config": {
"overbooking_limit": 3
},
"timebounds": {
"daily": {
"2026-10-16": {
"booking_id": "bk_9f31c2",
"is_enabled": true,
"bounds": [
{
"s": 1000,
"e": 1300,
"conf_ids": [
"conf_abc123"
]
}
]
}
}
},
"deleteTimebounds": {
"block": [
"bk_5a01e7"
]
}
}
'import requests
url = "https://api.eka.care/schedule/{scheduleId}"
payload = {
"config": { "overbooking_limit": 3 },
"timebounds": { "daily": { "2026-10-16": {
"booking_id": "bk_9f31c2",
"is_enabled": True,
"bounds": [
{
"s": 1000,
"e": 1300,
"conf_ids": ["conf_abc123"]
}
]
} } },
"deleteTimebounds": { "block": ["bk_5a01e7"] }
}
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({
config: {overbooking_limit: 3},
timebounds: {
daily: {
'2026-10-16': {
booking_id: 'bk_9f31c2',
is_enabled: true,
bounds: [{s: 1000, e: 1300, conf_ids: ['conf_abc123']}]
}
}
},
deleteTimebounds: {block: ['bk_5a01e7']}
})
};
fetch('https://api.eka.care/schedule/{scheduleId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.patch("https://api.eka.care/schedule/{scheduleId}")
.header("auth", "<auth>")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"overbooking_limit\": 3\n },\n \"timebounds\": {\n \"daily\": {\n \"2026-10-16\": {\n \"booking_id\": \"bk_9f31c2\",\n \"is_enabled\": true,\n \"bounds\": [\n {\n \"s\": 1000,\n \"e\": 1300,\n \"conf_ids\": [\n \"conf_abc123\"\n ]\n }\n ]\n }\n }\n },\n \"deleteTimebounds\": {\n \"block\": [\n \"bk_5a01e7\"\n ]\n }\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.eka.care/schedule/{scheduleId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("auth", "<auth>");
request.AddJsonBody("{\n \"config\": {\n \"overbooking_limit\": 3\n },\n \"timebounds\": {\n \"daily\": {\n \"2026-10-16\": {\n \"booking_id\": \"bk_9f31c2\",\n \"is_enabled\": true,\n \"bounds\": [\n {\n \"s\": 1000,\n \"e\": 1300,\n \"conf_ids\": [\n \"conf_abc123\"\n ]\n }\n ]\n }\n }\n },\n \"deleteTimebounds\": {\n \"block\": [\n \"bk_5a01e7\"\n ]\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/schedule/{scheduleId}")
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 \"config\": {\n \"overbooking_limit\": 3\n },\n \"timebounds\": {\n \"daily\": {\n \"2026-10-16\": {\n \"booking_id\": \"bk_9f31c2\",\n \"is_enabled\": true,\n \"bounds\": [\n {\n \"s\": 1000,\n \"e\": 1300,\n \"conf_ids\": [\n \"conf_abc123\"\n ]\n }\n ]\n }\n }\n },\n \"deleteTimebounds\": {\n \"block\": [\n \"bk_5a01e7\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"schedule_id": "<string>",
"business_id": "<string>",
"name": "<string>",
"archive": true,
"config": {
"overbooking_limit": 123,
"block_over_existing_bookings": true,
"schedule_slot_config_enabled": true,
"slot_durations": [
123
]
},
"timebounds": {},
"deleted": {},
"assignment": {
"bookable_by": [
"patient"
],
"products": [
"<string>"
],
"error": "<string>"
},
"confs_created": [
"<string>"
],
"failed_tasks": [
"<string>"
]
}
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "Unauthorised"
}{
"success": false,
"error": "schedule not found"
}{
"success": false,
"error": "<string>"
}Body
application/json
At least one field must be provided.
Was this page helpful?

