Create
curl --request POST \
--url https://api.example.com/api/schedule/schedules.create \
--header 'Content-Type: application/json' \
--data '
{
"resource_id": "872815618512410358",
"team_id": "872815618512410358",
"when": "RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR;DTSTART=20260101T120000;UNTIL=20260105T120000",
"hour_ranges": [
{
"hour_range": "12:34:56/PT2H",
"auto_correct": {
"before_start": "PT1H30M20S",
"after_start": "PT1H30M20S",
"before_end": "PT1H30M20S",
"after_end": "PT1H30M20S"
},
"paid_break": {
"max_duration": "PT1H30M20S",
"hour_range": "12:34:56/PT2H"
}
}
],
"options": {
"employee_resident_ratio": true,
"text_color": "<string>",
"special_hour_range": "12:34:56/PT2H",
"include_special_day_type_ids": [
"872815618512410358"
],
"allow_partial": false
},
"schedule_template_id": "872815618512410358",
"remark": "<string>"
}
'import requests
url = "https://api.example.com/api/schedule/schedules.create"
payload = {
"resource_id": "872815618512410358",
"team_id": "872815618512410358",
"when": "RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR;DTSTART=20260101T120000;UNTIL=20260105T120000",
"hour_ranges": [
{
"hour_range": "12:34:56/PT2H",
"auto_correct": {
"before_start": "PT1H30M20S",
"after_start": "PT1H30M20S",
"before_end": "PT1H30M20S",
"after_end": "PT1H30M20S"
},
"paid_break": {
"max_duration": "PT1H30M20S",
"hour_range": "12:34:56/PT2H"
}
}
],
"options": {
"employee_resident_ratio": True,
"text_color": "<string>",
"special_hour_range": "12:34:56/PT2H",
"include_special_day_type_ids": ["872815618512410358"],
"allow_partial": False
},
"schedule_template_id": "872815618512410358",
"remark": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
resource_id: '872815618512410358',
team_id: '872815618512410358',
when: 'RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR;DTSTART=20260101T120000;UNTIL=20260105T120000',
hour_ranges: [
{
hour_range: '12:34:56/PT2H',
auto_correct: {
before_start: 'PT1H30M20S',
after_start: 'PT1H30M20S',
before_end: 'PT1H30M20S',
after_end: 'PT1H30M20S'
},
paid_break: {max_duration: 'PT1H30M20S', hour_range: '12:34:56/PT2H'}
}
],
options: {
employee_resident_ratio: true,
text_color: '<string>',
special_hour_range: '12:34:56/PT2H',
include_special_day_type_ids: ['872815618512410358'],
allow_partial: false
},
schedule_template_id: '872815618512410358',
remark: '<string>'
})
};
fetch('https://api.example.com/api/schedule/schedules.create', 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://api.example.com/api/schedule/schedules.create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'resource_id' => '872815618512410358',
'team_id' => '872815618512410358',
'when' => 'RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR;DTSTART=20260101T120000;UNTIL=20260105T120000',
'hour_ranges' => [
[
'hour_range' => '12:34:56/PT2H',
'auto_correct' => [
'before_start' => 'PT1H30M20S',
'after_start' => 'PT1H30M20S',
'before_end' => 'PT1H30M20S',
'after_end' => 'PT1H30M20S'
],
'paid_break' => [
'max_duration' => 'PT1H30M20S',
'hour_range' => '12:34:56/PT2H'
]
]
],
'options' => [
'employee_resident_ratio' => true,
'text_color' => '<string>',
'special_hour_range' => '12:34:56/PT2H',
'include_special_day_type_ids' => [
'872815618512410358'
],
'allow_partial' => false
],
'schedule_template_id' => '872815618512410358',
'remark' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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://api.example.com/api/schedule/schedules.create"
payload := strings.NewReader("{\n \"resource_id\": \"872815618512410358\",\n \"team_id\": \"872815618512410358\",\n \"when\": \"RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR;DTSTART=20260101T120000;UNTIL=20260105T120000\",\n \"hour_ranges\": [\n {\n \"hour_range\": \"12:34:56/PT2H\",\n \"auto_correct\": {\n \"before_start\": \"PT1H30M20S\",\n \"after_start\": \"PT1H30M20S\",\n \"before_end\": \"PT1H30M20S\",\n \"after_end\": \"PT1H30M20S\"\n },\n \"paid_break\": {\n \"max_duration\": \"PT1H30M20S\",\n \"hour_range\": \"12:34:56/PT2H\"\n }\n }\n ],\n \"options\": {\n \"employee_resident_ratio\": true,\n \"text_color\": \"<string>\",\n \"special_hour_range\": \"12:34:56/PT2H\",\n \"include_special_day_type_ids\": [\n \"872815618512410358\"\n ],\n \"allow_partial\": false\n },\n \"schedule_template_id\": \"872815618512410358\",\n \"remark\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.post("https://api.example.com/api/schedule/schedules.create")
.header("Content-Type", "application/json")
.body("{\n \"resource_id\": \"872815618512410358\",\n \"team_id\": \"872815618512410358\",\n \"when\": \"RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR;DTSTART=20260101T120000;UNTIL=20260105T120000\",\n \"hour_ranges\": [\n {\n \"hour_range\": \"12:34:56/PT2H\",\n \"auto_correct\": {\n \"before_start\": \"PT1H30M20S\",\n \"after_start\": \"PT1H30M20S\",\n \"before_end\": \"PT1H30M20S\",\n \"after_end\": \"PT1H30M20S\"\n },\n \"paid_break\": {\n \"max_duration\": \"PT1H30M20S\",\n \"hour_range\": \"12:34:56/PT2H\"\n }\n }\n ],\n \"options\": {\n \"employee_resident_ratio\": true,\n \"text_color\": \"<string>\",\n \"special_hour_range\": \"12:34:56/PT2H\",\n \"include_special_day_type_ids\": [\n \"872815618512410358\"\n ],\n \"allow_partial\": false\n },\n \"schedule_template_id\": \"872815618512410358\",\n \"remark\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/schedule/schedules.create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"resource_id\": \"872815618512410358\",\n \"team_id\": \"872815618512410358\",\n \"when\": \"RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR;DTSTART=20260101T120000;UNTIL=20260105T120000\",\n \"hour_ranges\": [\n {\n \"hour_range\": \"12:34:56/PT2H\",\n \"auto_correct\": {\n \"before_start\": \"PT1H30M20S\",\n \"after_start\": \"PT1H30M20S\",\n \"before_end\": \"PT1H30M20S\",\n \"after_end\": \"PT1H30M20S\"\n },\n \"paid_break\": {\n \"max_duration\": \"PT1H30M20S\",\n \"hour_range\": \"12:34:56/PT2H\"\n }\n }\n ],\n \"options\": {\n \"employee_resident_ratio\": true,\n \"text_color\": \"<string>\",\n \"special_hour_range\": \"12:34:56/PT2H\",\n \"include_special_day_type_ids\": [\n \"872815618512410358\"\n ],\n \"allow_partial\": false\n },\n \"schedule_template_id\": \"872815618512410358\",\n \"remark\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"error": "OVERLAPPING",
"body": {
"conflicting_dates": [
{
"resource": "872815618512410358",
"date": "2019-11-11"
}
]
}
}Schedules
Create
Creates one schedule, or multiple schedules if when is a LocalDateInterval or an RRULE. The person you’re scheduling and the schedule template should belong to the team provided.
POST
/
api
/
schedule
/
schedules.create
Create
curl --request POST \
--url https://api.example.com/api/schedule/schedules.create \
--header 'Content-Type: application/json' \
--data '
{
"resource_id": "872815618512410358",
"team_id": "872815618512410358",
"when": "RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR;DTSTART=20260101T120000;UNTIL=20260105T120000",
"hour_ranges": [
{
"hour_range": "12:34:56/PT2H",
"auto_correct": {
"before_start": "PT1H30M20S",
"after_start": "PT1H30M20S",
"before_end": "PT1H30M20S",
"after_end": "PT1H30M20S"
},
"paid_break": {
"max_duration": "PT1H30M20S",
"hour_range": "12:34:56/PT2H"
}
}
],
"options": {
"employee_resident_ratio": true,
"text_color": "<string>",
"special_hour_range": "12:34:56/PT2H",
"include_special_day_type_ids": [
"872815618512410358"
],
"allow_partial": false
},
"schedule_template_id": "872815618512410358",
"remark": "<string>"
}
'import requests
url = "https://api.example.com/api/schedule/schedules.create"
payload = {
"resource_id": "872815618512410358",
"team_id": "872815618512410358",
"when": "RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR;DTSTART=20260101T120000;UNTIL=20260105T120000",
"hour_ranges": [
{
"hour_range": "12:34:56/PT2H",
"auto_correct": {
"before_start": "PT1H30M20S",
"after_start": "PT1H30M20S",
"before_end": "PT1H30M20S",
"after_end": "PT1H30M20S"
},
"paid_break": {
"max_duration": "PT1H30M20S",
"hour_range": "12:34:56/PT2H"
}
}
],
"options": {
"employee_resident_ratio": True,
"text_color": "<string>",
"special_hour_range": "12:34:56/PT2H",
"include_special_day_type_ids": ["872815618512410358"],
"allow_partial": False
},
"schedule_template_id": "872815618512410358",
"remark": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
resource_id: '872815618512410358',
team_id: '872815618512410358',
when: 'RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR;DTSTART=20260101T120000;UNTIL=20260105T120000',
hour_ranges: [
{
hour_range: '12:34:56/PT2H',
auto_correct: {
before_start: 'PT1H30M20S',
after_start: 'PT1H30M20S',
before_end: 'PT1H30M20S',
after_end: 'PT1H30M20S'
},
paid_break: {max_duration: 'PT1H30M20S', hour_range: '12:34:56/PT2H'}
}
],
options: {
employee_resident_ratio: true,
text_color: '<string>',
special_hour_range: '12:34:56/PT2H',
include_special_day_type_ids: ['872815618512410358'],
allow_partial: false
},
schedule_template_id: '872815618512410358',
remark: '<string>'
})
};
fetch('https://api.example.com/api/schedule/schedules.create', 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://api.example.com/api/schedule/schedules.create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'resource_id' => '872815618512410358',
'team_id' => '872815618512410358',
'when' => 'RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR;DTSTART=20260101T120000;UNTIL=20260105T120000',
'hour_ranges' => [
[
'hour_range' => '12:34:56/PT2H',
'auto_correct' => [
'before_start' => 'PT1H30M20S',
'after_start' => 'PT1H30M20S',
'before_end' => 'PT1H30M20S',
'after_end' => 'PT1H30M20S'
],
'paid_break' => [
'max_duration' => 'PT1H30M20S',
'hour_range' => '12:34:56/PT2H'
]
]
],
'options' => [
'employee_resident_ratio' => true,
'text_color' => '<string>',
'special_hour_range' => '12:34:56/PT2H',
'include_special_day_type_ids' => [
'872815618512410358'
],
'allow_partial' => false
],
'schedule_template_id' => '872815618512410358',
'remark' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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://api.example.com/api/schedule/schedules.create"
payload := strings.NewReader("{\n \"resource_id\": \"872815618512410358\",\n \"team_id\": \"872815618512410358\",\n \"when\": \"RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR;DTSTART=20260101T120000;UNTIL=20260105T120000\",\n \"hour_ranges\": [\n {\n \"hour_range\": \"12:34:56/PT2H\",\n \"auto_correct\": {\n \"before_start\": \"PT1H30M20S\",\n \"after_start\": \"PT1H30M20S\",\n \"before_end\": \"PT1H30M20S\",\n \"after_end\": \"PT1H30M20S\"\n },\n \"paid_break\": {\n \"max_duration\": \"PT1H30M20S\",\n \"hour_range\": \"12:34:56/PT2H\"\n }\n }\n ],\n \"options\": {\n \"employee_resident_ratio\": true,\n \"text_color\": \"<string>\",\n \"special_hour_range\": \"12:34:56/PT2H\",\n \"include_special_day_type_ids\": [\n \"872815618512410358\"\n ],\n \"allow_partial\": false\n },\n \"schedule_template_id\": \"872815618512410358\",\n \"remark\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.post("https://api.example.com/api/schedule/schedules.create")
.header("Content-Type", "application/json")
.body("{\n \"resource_id\": \"872815618512410358\",\n \"team_id\": \"872815618512410358\",\n \"when\": \"RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR;DTSTART=20260101T120000;UNTIL=20260105T120000\",\n \"hour_ranges\": [\n {\n \"hour_range\": \"12:34:56/PT2H\",\n \"auto_correct\": {\n \"before_start\": \"PT1H30M20S\",\n \"after_start\": \"PT1H30M20S\",\n \"before_end\": \"PT1H30M20S\",\n \"after_end\": \"PT1H30M20S\"\n },\n \"paid_break\": {\n \"max_duration\": \"PT1H30M20S\",\n \"hour_range\": \"12:34:56/PT2H\"\n }\n }\n ],\n \"options\": {\n \"employee_resident_ratio\": true,\n \"text_color\": \"<string>\",\n \"special_hour_range\": \"12:34:56/PT2H\",\n \"include_special_day_type_ids\": [\n \"872815618512410358\"\n ],\n \"allow_partial\": false\n },\n \"schedule_template_id\": \"872815618512410358\",\n \"remark\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/schedule/schedules.create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"resource_id\": \"872815618512410358\",\n \"team_id\": \"872815618512410358\",\n \"when\": \"RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR;DTSTART=20260101T120000;UNTIL=20260105T120000\",\n \"hour_ranges\": [\n {\n \"hour_range\": \"12:34:56/PT2H\",\n \"auto_correct\": {\n \"before_start\": \"PT1H30M20S\",\n \"after_start\": \"PT1H30M20S\",\n \"before_end\": \"PT1H30M20S\",\n \"after_end\": \"PT1H30M20S\"\n },\n \"paid_break\": {\n \"max_duration\": \"PT1H30M20S\",\n \"hour_range\": \"12:34:56/PT2H\"\n }\n }\n ],\n \"options\": {\n \"employee_resident_ratio\": true,\n \"text_color\": \"<string>\",\n \"special_hour_range\": \"12:34:56/PT2H\",\n \"include_special_day_type_ids\": [\n \"872815618512410358\"\n ],\n \"allow_partial\": false\n },\n \"schedule_template_id\": \"872815618512410358\",\n \"remark\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"error": "OVERLAPPING",
"body": {
"conflicting_dates": [
{
"resource": "872815618512410358",
"date": "2019-11-11"
}
]
}
}A stable version of this route is available: 26.06.25.
This page is a preview of upcoming changes to this route: they may change without notice until they become part of a new stable version.
Body
application/json
Example:
"872815618512410358"
Example:
"872815618512410358"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
"872815618512410358"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Schedule(s) successfully created.