Skip to main content
PATCH
/
schedules
/
{schedule_id}
Update Schedule
curl --request PATCH \
  --url https://api.example.com/schedules/{schedule_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "cron_expr": "<string>",
  "endpoint": "<string>",
  "method": "<string>",
  "description": "<string>",
  "payload": {},
  "timezone": "<string>",
  "timeout_seconds": 43200,
  "max_retries": 5,
  "retry_delay_seconds": 1800
}
'
import requests

url = "https://api.example.com/schedules/{schedule_id}"

payload = {
"name": "<string>",
"cron_expr": "<string>",
"endpoint": "<string>",
"method": "<string>",
"description": "<string>",
"payload": {},
"timezone": "<string>",
"timeout_seconds": 43200,
"max_retries": 5,
"retry_delay_seconds": 1800
}
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>',
cron_expr: '<string>',
endpoint: '<string>',
method: '<string>',
description: '<string>',
payload: {},
timezone: '<string>',
timeout_seconds: 43200,
max_retries: 5,
retry_delay_seconds: 1800
})
};

fetch('https://api.example.com/schedules/{schedule_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://api.example.com/schedules/{schedule_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>',
'cron_expr' => '<string>',
'endpoint' => '<string>',
'method' => '<string>',
'description' => '<string>',
'payload' => [

],
'timezone' => '<string>',
'timeout_seconds' => 43200,
'max_retries' => 5,
'retry_delay_seconds' => 1800
]),
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.example.com/schedules/{schedule_id}"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"cron_expr\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"method\": \"<string>\",\n \"description\": \"<string>\",\n \"payload\": {},\n \"timezone\": \"<string>\",\n \"timeout_seconds\": 43200,\n \"max_retries\": 5,\n \"retry_delay_seconds\": 1800\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://api.example.com/schedules/{schedule_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"cron_expr\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"method\": \"<string>\",\n \"description\": \"<string>\",\n \"payload\": {},\n \"timezone\": \"<string>\",\n \"timeout_seconds\": 43200,\n \"max_retries\": 5,\n \"retry_delay_seconds\": 1800\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/schedules/{schedule_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 \"cron_expr\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"method\": \"<string>\",\n \"description\": \"<string>\",\n \"payload\": {},\n \"timezone\": \"<string>\",\n \"timeout_seconds\": 43200,\n \"max_retries\": 5,\n \"retry_delay_seconds\": 1800\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "name": "<string>",
  "method": "<string>",
  "endpoint": "<string>",
  "cron_expr": "<string>",
  "timezone": "<string>",
  "timeout_seconds": 123,
  "max_retries": 123,
  "retry_delay_seconds": 123,
  "enabled": true,
  "description": "<string>",
  "payload": {},
  "next_run_at": 123,
  "created_at": 123,
  "updated_at": 123
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

schedule_id
string
required

Body

application/json
name
string | null
Maximum string length: 255
cron_expr
string | null
Maximum string length: 128
endpoint
string | null
Maximum string length: 512
method
string | null
Maximum string length: 10
description
string | null
Maximum string length: 1024
payload
Payload · object | null
timezone
string | null
Maximum string length: 64
timeout_seconds
integer | null
Required range: 1 <= x <= 86400
max_retries
integer | null
Required range: 0 <= x <= 10
retry_delay_seconds
integer | null
Required range: 1 <= x <= 3600

Response

Successful Response

id
string
required
name
string
required
method
string
required
endpoint
string
required
cron_expr
string
required
timezone
string
required
timeout_seconds
integer
required
max_retries
integer
required
retry_delay_seconds
integer
required
enabled
boolean
required
description
string | null
payload
Payload · object | null
next_run_at
integer | null
created_at
integer | null
updated_at
integer | null