Update Schedule
Update a recurring schedule. Omitted fields are preserved; an empty respected_holiday_window_ids update clears every holiday reference.
curl --request PATCH \
--url https://public.api.serval.com/v2/schedules/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"timezone": "<string>",
"weeklyHours": {
"sunday": [
{
"start": "<string>",
"end": "<string>"
}
],
"monday": [
{
"start": "<string>",
"end": "<string>"
}
],
"tuesday": [
{
"start": "<string>",
"end": "<string>"
}
],
"wednesday": [
{
"start": "<string>",
"end": "<string>"
}
],
"thursday": [
{
"start": "<string>",
"end": "<string>"
}
],
"friday": [
{
"start": "<string>",
"end": "<string>"
}
],
"saturday": [
{
"start": "<string>",
"end": "<string>"
}
]
},
"respectedHolidayWindowIds": {
"ids": [
"<string>"
]
},
"scopedId": "<string>"
}
'import requests
url = "https://public.api.serval.com/v2/schedules/{id}"
payload = {
"name": "<string>",
"timezone": "<string>",
"weeklyHours": {
"sunday": [
{
"start": "<string>",
"end": "<string>"
}
],
"monday": [
{
"start": "<string>",
"end": "<string>"
}
],
"tuesday": [
{
"start": "<string>",
"end": "<string>"
}
],
"wednesday": [
{
"start": "<string>",
"end": "<string>"
}
],
"thursday": [
{
"start": "<string>",
"end": "<string>"
}
],
"friday": [
{
"start": "<string>",
"end": "<string>"
}
],
"saturday": [
{
"start": "<string>",
"end": "<string>"
}
]
},
"respectedHolidayWindowIds": { "ids": ["<string>"] },
"scopedId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
timezone: '<string>',
weeklyHours: {
sunday: [{start: '<string>', end: '<string>'}],
monday: [{start: '<string>', end: '<string>'}],
tuesday: [{start: '<string>', end: '<string>'}],
wednesday: [{start: '<string>', end: '<string>'}],
thursday: [{start: '<string>', end: '<string>'}],
friday: [{start: '<string>', end: '<string>'}],
saturday: [{start: '<string>', end: '<string>'}]
},
respectedHolidayWindowIds: {ids: ['<string>']},
scopedId: '<string>'
})
};
fetch('https://public.api.serval.com/v2/schedules/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://public.api.serval.com/v2/schedules/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'timezone' => '<string>',
'weeklyHours' => [
'sunday' => [
[
'start' => '<string>',
'end' => '<string>'
]
],
'monday' => [
[
'start' => '<string>',
'end' => '<string>'
]
],
'tuesday' => [
[
'start' => '<string>',
'end' => '<string>'
]
],
'wednesday' => [
[
'start' => '<string>',
'end' => '<string>'
]
],
'thursday' => [
[
'start' => '<string>',
'end' => '<string>'
]
],
'friday' => [
[
'start' => '<string>',
'end' => '<string>'
]
],
'saturday' => [
[
'start' => '<string>',
'end' => '<string>'
]
]
],
'respectedHolidayWindowIds' => [
'ids' => [
'<string>'
]
],
'scopedId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://public.api.serval.com/v2/schedules/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"timezone\": \"<string>\",\n \"weeklyHours\": {\n \"sunday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"monday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"tuesday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"wednesday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"thursday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"friday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"saturday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ]\n },\n \"respectedHolidayWindowIds\": {\n \"ids\": [\n \"<string>\"\n ]\n },\n \"scopedId\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://public.api.serval.com/v2/schedules/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"timezone\": \"<string>\",\n \"weeklyHours\": {\n \"sunday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"monday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"tuesday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"wednesday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"thursday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"friday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"saturday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ]\n },\n \"respectedHolidayWindowIds\": {\n \"ids\": [\n \"<string>\"\n ]\n },\n \"scopedId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public.api.serval.com/v2/schedules/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"timezone\": \"<string>\",\n \"weeklyHours\": {\n \"sunday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"monday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"tuesday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"wednesday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"thursday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"friday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"saturday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ]\n },\n \"respectedHolidayWindowIds\": {\n \"ids\": [\n \"<string>\"\n ]\n },\n \"scopedId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"teamId": "<string>",
"name": "<string>",
"timezone": "<string>",
"weeklyHours": {
"sunday": [
{
"start": "<string>",
"end": "<string>"
}
],
"monday": [
{
"start": "<string>",
"end": "<string>"
}
],
"tuesday": [
{
"start": "<string>",
"end": "<string>"
}
],
"wednesday": [
{
"start": "<string>",
"end": "<string>"
}
],
"thursday": [
{
"start": "<string>",
"end": "<string>"
}
],
"friday": [
{
"start": "<string>",
"end": "<string>"
}
],
"saturday": [
{
"start": "<string>",
"end": "<string>"
}
]
},
"createdAt": "2025-01-15T01:30:15.000Z",
"updatedAt": "2025-01-15T01:30:15.000Z",
"kind": "SCHEDULE_KIND_UNSPECIFIED",
"respectedHolidayWindowIds": [
"<string>"
],
"scopedId": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
WeeklyHours defines business hours for each day of the week.
Show child attributes
Show child attributes
ScheduleKind distinguishes a recurring weekly schedule's role.
SCHEDULE_KIND_UNSPECIFIED, SCHEDULE_KIND_WORK_HOURS, SCHEDULE_KIND_BLACKOUT Omit to preserve the current set; send an empty ids list to clear it.
Show child attributes
Show child attributes
Rekeys the copy-invariant identity. Omit to preserve it.
Response
Success
Schedule represents a recurring weekly time pattern. A WORK_HOURS schedule feeds the SLA clock (when it runs); a BLACKOUT schedule feeds the change-management conflict engine (when changes are blocked).
Show child attributes
Show child attributes
Was this page helpful?
curl --request PATCH \
--url https://public.api.serval.com/v2/schedules/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"timezone": "<string>",
"weeklyHours": {
"sunday": [
{
"start": "<string>",
"end": "<string>"
}
],
"monday": [
{
"start": "<string>",
"end": "<string>"
}
],
"tuesday": [
{
"start": "<string>",
"end": "<string>"
}
],
"wednesday": [
{
"start": "<string>",
"end": "<string>"
}
],
"thursday": [
{
"start": "<string>",
"end": "<string>"
}
],
"friday": [
{
"start": "<string>",
"end": "<string>"
}
],
"saturday": [
{
"start": "<string>",
"end": "<string>"
}
]
},
"respectedHolidayWindowIds": {
"ids": [
"<string>"
]
},
"scopedId": "<string>"
}
'import requests
url = "https://public.api.serval.com/v2/schedules/{id}"
payload = {
"name": "<string>",
"timezone": "<string>",
"weeklyHours": {
"sunday": [
{
"start": "<string>",
"end": "<string>"
}
],
"monday": [
{
"start": "<string>",
"end": "<string>"
}
],
"tuesday": [
{
"start": "<string>",
"end": "<string>"
}
],
"wednesday": [
{
"start": "<string>",
"end": "<string>"
}
],
"thursday": [
{
"start": "<string>",
"end": "<string>"
}
],
"friday": [
{
"start": "<string>",
"end": "<string>"
}
],
"saturday": [
{
"start": "<string>",
"end": "<string>"
}
]
},
"respectedHolidayWindowIds": { "ids": ["<string>"] },
"scopedId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
timezone: '<string>',
weeklyHours: {
sunday: [{start: '<string>', end: '<string>'}],
monday: [{start: '<string>', end: '<string>'}],
tuesday: [{start: '<string>', end: '<string>'}],
wednesday: [{start: '<string>', end: '<string>'}],
thursday: [{start: '<string>', end: '<string>'}],
friday: [{start: '<string>', end: '<string>'}],
saturday: [{start: '<string>', end: '<string>'}]
},
respectedHolidayWindowIds: {ids: ['<string>']},
scopedId: '<string>'
})
};
fetch('https://public.api.serval.com/v2/schedules/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://public.api.serval.com/v2/schedules/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'timezone' => '<string>',
'weeklyHours' => [
'sunday' => [
[
'start' => '<string>',
'end' => '<string>'
]
],
'monday' => [
[
'start' => '<string>',
'end' => '<string>'
]
],
'tuesday' => [
[
'start' => '<string>',
'end' => '<string>'
]
],
'wednesday' => [
[
'start' => '<string>',
'end' => '<string>'
]
],
'thursday' => [
[
'start' => '<string>',
'end' => '<string>'
]
],
'friday' => [
[
'start' => '<string>',
'end' => '<string>'
]
],
'saturday' => [
[
'start' => '<string>',
'end' => '<string>'
]
]
],
'respectedHolidayWindowIds' => [
'ids' => [
'<string>'
]
],
'scopedId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://public.api.serval.com/v2/schedules/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"timezone\": \"<string>\",\n \"weeklyHours\": {\n \"sunday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"monday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"tuesday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"wednesday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"thursday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"friday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"saturday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ]\n },\n \"respectedHolidayWindowIds\": {\n \"ids\": [\n \"<string>\"\n ]\n },\n \"scopedId\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://public.api.serval.com/v2/schedules/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"timezone\": \"<string>\",\n \"weeklyHours\": {\n \"sunday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"monday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"tuesday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"wednesday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"thursday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"friday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"saturday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ]\n },\n \"respectedHolidayWindowIds\": {\n \"ids\": [\n \"<string>\"\n ]\n },\n \"scopedId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public.api.serval.com/v2/schedules/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"timezone\": \"<string>\",\n \"weeklyHours\": {\n \"sunday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"monday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"tuesday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"wednesday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"thursday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"friday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ],\n \"saturday\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n ]\n },\n \"respectedHolidayWindowIds\": {\n \"ids\": [\n \"<string>\"\n ]\n },\n \"scopedId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"teamId": "<string>",
"name": "<string>",
"timezone": "<string>",
"weeklyHours": {
"sunday": [
{
"start": "<string>",
"end": "<string>"
}
],
"monday": [
{
"start": "<string>",
"end": "<string>"
}
],
"tuesday": [
{
"start": "<string>",
"end": "<string>"
}
],
"wednesday": [
{
"start": "<string>",
"end": "<string>"
}
],
"thursday": [
{
"start": "<string>",
"end": "<string>"
}
],
"friday": [
{
"start": "<string>",
"end": "<string>"
}
],
"saturday": [
{
"start": "<string>",
"end": "<string>"
}
]
},
"createdAt": "2025-01-15T01:30:15.000Z",
"updatedAt": "2025-01-15T01:30:15.000Z",
"kind": "SCHEDULE_KIND_UNSPECIFIED",
"respectedHolidayWindowIds": [
"<string>"
],
"scopedId": "<string>"
}
}
