Holiday Schemes
Add holiday to scheme
Creates one holiday within the specified scheme.
POST
/
v1
/
public
/
holiday-schemes
/
{schemeId}
/
holidays
Add holiday to scheme
curl --request POST \
--url https://api.agile-tools.io/v1/public/holiday-schemes/{schemeId}/holidays \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"durationDays": 2,
"externalId": "<string>",
"description": "<string>",
"day": 1,
"month": 1,
"year": 2026,
"floatingRule": "first Monday in May"
}
'import requests
url = "https://api.agile-tools.io/v1/public/holiday-schemes/{schemeId}/holidays"
payload = {
"name": "<string>",
"durationDays": 2,
"externalId": "<string>",
"description": "<string>",
"day": 1,
"month": 1,
"year": 2026,
"floatingRule": "first Monday in May"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
durationDays: 2,
externalId: '<string>',
description: '<string>',
day: 1,
month: 1,
year: 2026,
floatingRule: 'first Monday in May'
})
};
fetch('https://api.agile-tools.io/v1/public/holiday-schemes/{schemeId}/holidays', 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.agile-tools.io/v1/public/holiday-schemes/{schemeId}/holidays",
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([
'name' => '<string>',
'durationDays' => 2,
'externalId' => '<string>',
'description' => '<string>',
'day' => 1,
'month' => 1,
'year' => 2026,
'floatingRule' => 'first Monday in May'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.agile-tools.io/v1/public/holiday-schemes/{schemeId}/holidays"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"durationDays\": 2,\n \"externalId\": \"<string>\",\n \"description\": \"<string>\",\n \"day\": 1,\n \"month\": 1,\n \"year\": 2026,\n \"floatingRule\": \"first Monday in May\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.agile-tools.io/v1/public/holiday-schemes/{schemeId}/holidays")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"durationDays\": 2,\n \"externalId\": \"<string>\",\n \"description\": \"<string>\",\n \"day\": 1,\n \"month\": 1,\n \"year\": 2026,\n \"floatingRule\": \"first Monday in May\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.agile-tools.io/v1/public/holiday-schemes/{schemeId}/holidays")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"durationDays\": 2,\n \"externalId\": \"<string>\",\n \"description\": \"<string>\",\n \"day\": 1,\n \"month\": 1,\n \"year\": 2026,\n \"floatingRule\": \"first Monday in May\"\n}"
response = http.request(request)
puts response.read_body{
"data": {},
"meta": {
"requestId": "<string>",
"timestamp": "2022-03-10T16:15:50Z",
"pagination": {
"mode": "<string>",
"totalCount": 123,
"page": 123,
"limit": 123,
"totalPages": 123,
"hasNext": true,
"hasPrevious": true,
"nextCursor": "<string>",
"hasMore": true
},
"library": {
"tabCounts": {}
}
}
}Authorizations
Body
application/json
Fixed or floating holiday fields.
⌘I
Add holiday to scheme
curl --request POST \
--url https://api.agile-tools.io/v1/public/holiday-schemes/{schemeId}/holidays \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"durationDays": 2,
"externalId": "<string>",
"description": "<string>",
"day": 1,
"month": 1,
"year": 2026,
"floatingRule": "first Monday in May"
}
'import requests
url = "https://api.agile-tools.io/v1/public/holiday-schemes/{schemeId}/holidays"
payload = {
"name": "<string>",
"durationDays": 2,
"externalId": "<string>",
"description": "<string>",
"day": 1,
"month": 1,
"year": 2026,
"floatingRule": "first Monday in May"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
durationDays: 2,
externalId: '<string>',
description: '<string>',
day: 1,
month: 1,
year: 2026,
floatingRule: 'first Monday in May'
})
};
fetch('https://api.agile-tools.io/v1/public/holiday-schemes/{schemeId}/holidays', 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.agile-tools.io/v1/public/holiday-schemes/{schemeId}/holidays",
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([
'name' => '<string>',
'durationDays' => 2,
'externalId' => '<string>',
'description' => '<string>',
'day' => 1,
'month' => 1,
'year' => 2026,
'floatingRule' => 'first Monday in May'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.agile-tools.io/v1/public/holiday-schemes/{schemeId}/holidays"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"durationDays\": 2,\n \"externalId\": \"<string>\",\n \"description\": \"<string>\",\n \"day\": 1,\n \"month\": 1,\n \"year\": 2026,\n \"floatingRule\": \"first Monday in May\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.agile-tools.io/v1/public/holiday-schemes/{schemeId}/holidays")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"durationDays\": 2,\n \"externalId\": \"<string>\",\n \"description\": \"<string>\",\n \"day\": 1,\n \"month\": 1,\n \"year\": 2026,\n \"floatingRule\": \"first Monday in May\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.agile-tools.io/v1/public/holiday-schemes/{schemeId}/holidays")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"durationDays\": 2,\n \"externalId\": \"<string>\",\n \"description\": \"<string>\",\n \"day\": 1,\n \"month\": 1,\n \"year\": 2026,\n \"floatingRule\": \"first Monday in May\"\n}"
response = http.request(request)
puts response.read_body{
"data": {},
"meta": {
"requestId": "<string>",
"timestamp": "2022-03-10T16:15:50Z",
"pagination": {
"mode": "<string>",
"totalCount": 123,
"page": 123,
"limit": 123,
"totalPages": 123,
"hasNext": true,
"hasPrevious": true,
"nextCursor": "<string>",
"hasMore": true
},
"library": {
"tabCounts": {}
}
}
}
