Skip to main content
POST
/
schedule
/
v1
/
planners
/
{plannerId}
/
free-days
Assign Free Days to Employees in Planner
curl --request POST \
  --url https://api-{region}.sesametime.com/schedule/v1/planners/{plannerId}/free-days \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": "2026-02-10",
  "to": "2026-02-12",
  "employeeIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "comments": "Personal day",
  "ranges": [
    {
      "from": "09:00",
      "to": "14:00"
    }
  ]
}
'
import requests

url = "https://api-{region}.sesametime.com/schedule/v1/planners/{plannerId}/free-days"

payload = {
"from": "2026-02-10",
"to": "2026-02-12",
"employeeIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"comments": "Personal day",
"ranges": [
{
"from": "09:00",
"to": "14:00"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
from: '2026-02-10',
to: '2026-02-12',
employeeIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
comments: 'Personal day',
ranges: [{from: '09:00', to: '14:00'}]
})
};

fetch('https://api-{region}.sesametime.com/schedule/v1/planners/{plannerId}/free-days', 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-{region}.sesametime.com/schedule/v1/planners/{plannerId}/free-days",
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([
'from' => '2026-02-10',
'to' => '2026-02-12',
'employeeIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'comments' => 'Personal day',
'ranges' => [
[
'from' => '09:00',
'to' => '14:00'
]
]
]),
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://api-{region}.sesametime.com/schedule/v1/planners/{plannerId}/free-days"

payload := strings.NewReader("{\n \"from\": \"2026-02-10\",\n \"to\": \"2026-02-12\",\n \"employeeIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"comments\": \"Personal day\",\n \"ranges\": [\n {\n \"from\": \"09:00\",\n \"to\": \"14:00\"\n }\n ]\n}")

req, _ := http.NewRequest("POST", 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.post("https://api-{region}.sesametime.com/schedule/v1/planners/{plannerId}/free-days")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"from\": \"2026-02-10\",\n \"to\": \"2026-02-12\",\n \"employeeIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"comments\": \"Personal day\",\n \"ranges\": [\n {\n \"from\": \"09:00\",\n \"to\": \"14:00\"\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api-{region}.sesametime.com/schedule/v1/planners/{plannerId}/free-days")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"from\": \"2026-02-10\",\n \"to\": \"2026-02-12\",\n \"employeeIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"comments\": \"Personal day\",\n \"ranges\": [\n {\n \"from\": \"09:00\",\n \"to\": \"14:00\"\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "data": "",
  "meta": {
    "currentPage": 1,
    "lastPage": 1,
    "total": 1,
    "perPage": 1
  }
}
{
"message": "Validation failed",
"errors": [
{
"field": "questionId",
"message": "This value is not a valid UUID."
},
{
"field": "answer",
"message": "This field is required for text-based questions."
}
]
}
{
"message": "Invalid or missing API Key",
"code": "UNAUTHORIZED"
}
{
"message": "Evaluation with ID 123e4567-e89b-12d3-a456-426614174000 was not found",
"code": "EVALUATION_NOT_FOUND"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

plannerId
string<uuid>
required

The planner ID

Body

application/json
from
string<date>
required

Start of the range (Y-m-d). Inclusive.

Example:

"2026-02-10"

to
string<date>
required

End of the range (Y-m-d). Inclusive. Max range: 3 years.

Example:

"2026-02-12"

employeeIds
string<uuid>[]
required

Employees to assign the free days to.

comments
string | null

Optional comments attached to each free day.

Maximum string length: 255
Example:

"Personal day"

ranges
object[] | null

Optional time ranges that define partial free days. Must not overlap and must total less than 24 hours.

Response

Object

data
string
Example:

""

meta
object