Skip to main content
PATCH
/
api
/
v1
/
calendars
/
{calendarId}
/
schedules
/
{scheduleId}
Update a schedule
curl --request PATCH \
  --url https://prod.featherhq.com/api/v1/calendars/{calendarId}/schedules/{scheduleId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "timezone": "<string>",
  "isDefault": true,
  "availability": [
    {
      "startTime": 720,
      "endTime": 720,
      "days": [],
      "date": "2023-12-25"
    }
  ]
}
'
import requests

url = "https://prod.featherhq.com/api/v1/calendars/{calendarId}/schedules/{scheduleId}"

payload = {
"name": "<string>",
"timezone": "<string>",
"isDefault": True,
"availability": [
{
"startTime": 720,
"endTime": 720,
"days": [],
"date": "2023-12-25"
}
]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
timezone: '<string>',
isDefault: true,
availability: [{startTime: 720, endTime: 720, days: [], date: '2023-12-25'}]
})
};

fetch('https://prod.featherhq.com/api/v1/calendars/{calendarId}/schedules/{scheduleId}', 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://prod.featherhq.com/api/v1/calendars/{calendarId}/schedules/{scheduleId}",
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>',
'isDefault' => true,
'availability' => [
[
'startTime' => 720,
'endTime' => 720,
'days' => [

],
'date' => '2023-12-25'
]
]
]),
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://prod.featherhq.com/api/v1/calendars/{calendarId}/schedules/{scheduleId}"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"timezone\": \"<string>\",\n \"isDefault\": true,\n \"availability\": [\n {\n \"startTime\": 720,\n \"endTime\": 720,\n \"days\": [],\n \"date\": \"2023-12-25\"\n }\n ]\n}")

req, _ := http.NewRequest("PATCH", 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.patch("https://prod.featherhq.com/api/v1/calendars/{calendarId}/schedules/{scheduleId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"timezone\": \"<string>\",\n \"isDefault\": true,\n \"availability\": [\n {\n \"startTime\": 720,\n \"endTime\": 720,\n \"days\": [],\n \"date\": \"2023-12-25\"\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://prod.featherhq.com/api/v1/calendars/{calendarId}/schedules/{scheduleId}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"timezone\": \"<string>\",\n \"isDefault\": true,\n \"availability\": [\n {\n \"startTime\": 720,\n \"endTime\": 720,\n \"days\": [],\n \"date\": \"2023-12-25\"\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "calendarId": "<string>",
  "name": "<string>",
  "timezone": "<string>",
  "isDefault": true,
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "availabilities": [
    {
      "id": "<string>",
      "days": [
        3
      ],
      "startTime": 720,
      "endTime": 720,
      "date": "<string>"
    }
  ]
}
{
"status": 400,
"message": "Bad request",
"code": "BAD_REQUEST",
"success": false
}
{
"status": 404,
"message": "Not found",
"code": "NOT_FOUND",
"success": false
}
{
"status": 500,
"message": "Internal server error",
"code": "INTERNAL_SERVER_ERROR",
"success": false
}

Authorizations

X-API-Key
string
header
required

Path Parameters

calendarId
string
required
scheduleId
string
required

Body

application/json
name
string
Required string length: 1 - 255
timezone
string
isDefault
boolean
availability
object[]

Response

Schedule updated

id
string
required
calendarId
string
required
name
string
required
timezone
string
required
isDefault
boolean
required
createdAt
string
required
updatedAt
string
required
availabilities
object[]
required