Update a schedule
curl --request PATCH \
--url https://api.getdialed.ai/v1/flows/schedules/{sched_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"cron_expression": "<string>",
"enabled": true,
"input_data": {},
"description": "<string>",
"metadata": {}
}
'import requests
url = "https://api.getdialed.ai/v1/flows/schedules/{sched_id}"
payload = {
"cron_expression": "<string>",
"enabled": True,
"input_data": {},
"description": "<string>",
"metadata": {}
}
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({
cron_expression: '<string>',
enabled: true,
input_data: {},
description: '<string>',
metadata: {}
})
};
fetch('https://api.getdialed.ai/v1/flows/schedules/{sched_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.getdialed.ai/v1/flows/schedules/{sched_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([
'cron_expression' => '<string>',
'enabled' => true,
'input_data' => [
],
'description' => '<string>',
'metadata' => [
]
]),
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.getdialed.ai/v1/flows/schedules/{sched_id}"
payload := strings.NewReader("{\n \"cron_expression\": \"<string>\",\n \"enabled\": true,\n \"input_data\": {},\n \"description\": \"<string>\",\n \"metadata\": {}\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://api.getdialed.ai/v1/flows/schedules/{sched_id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cron_expression\": \"<string>\",\n \"enabled\": true,\n \"input_data\": {},\n \"description\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getdialed.ai/v1/flows/schedules/{sched_id}")
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 \"cron_expression\": \"<string>\",\n \"enabled\": true,\n \"input_data\": {},\n \"description\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2026-07-09T09:00:00Z",
"cron_expression": "0 9 * * 1-5",
"definition_id": "def_a1b2c3d4",
"description": "Nightly Five9 report sync",
"enabled": true,
"id": "sched_1a2b3c4d",
"input_data": {
"report": "daily_calls"
},
"metadata": {
"owner": "ops"
},
"next_fire_at": "2026-07-10T09:00:00Z",
"org_id": "org_e5f6g7h8",
"updated_at": "2026-07-09T09:00:00Z"
}{
"detail": "Authentication required"
}{
"detail": "Admin role required"
}{
"detail": "Schedule not found (or backing schedule gone)"
}{
"detail": "Validation error"
}{
"detail": "Rate limit exceeded"
}{
"detail": "Schedule update failed, change rolled back — retry"
}Schedules
Update a schedule
Partial update. Changing cron_expression re-times the backing schedule; toggling enabled pauses/unpauses it; other fields update the record only. definition_id is immutable. Cross-tenant access returns 404.
PATCH
/
flows
/
schedules
/
{sched_id}
Update a schedule
curl --request PATCH \
--url https://api.getdialed.ai/v1/flows/schedules/{sched_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"cron_expression": "<string>",
"enabled": true,
"input_data": {},
"description": "<string>",
"metadata": {}
}
'import requests
url = "https://api.getdialed.ai/v1/flows/schedules/{sched_id}"
payload = {
"cron_expression": "<string>",
"enabled": True,
"input_data": {},
"description": "<string>",
"metadata": {}
}
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({
cron_expression: '<string>',
enabled: true,
input_data: {},
description: '<string>',
metadata: {}
})
};
fetch('https://api.getdialed.ai/v1/flows/schedules/{sched_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.getdialed.ai/v1/flows/schedules/{sched_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([
'cron_expression' => '<string>',
'enabled' => true,
'input_data' => [
],
'description' => '<string>',
'metadata' => [
]
]),
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.getdialed.ai/v1/flows/schedules/{sched_id}"
payload := strings.NewReader("{\n \"cron_expression\": \"<string>\",\n \"enabled\": true,\n \"input_data\": {},\n \"description\": \"<string>\",\n \"metadata\": {}\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://api.getdialed.ai/v1/flows/schedules/{sched_id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cron_expression\": \"<string>\",\n \"enabled\": true,\n \"input_data\": {},\n \"description\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getdialed.ai/v1/flows/schedules/{sched_id}")
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 \"cron_expression\": \"<string>\",\n \"enabled\": true,\n \"input_data\": {},\n \"description\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2026-07-09T09:00:00Z",
"cron_expression": "0 9 * * 1-5",
"definition_id": "def_a1b2c3d4",
"description": "Nightly Five9 report sync",
"enabled": true,
"id": "sched_1a2b3c4d",
"input_data": {
"report": "daily_calls"
},
"metadata": {
"owner": "ops"
},
"next_fire_at": "2026-07-10T09:00:00Z",
"org_id": "org_e5f6g7h8",
"updated_at": "2026-07-09T09:00:00Z"
}{
"detail": "Authentication required"
}{
"detail": "Admin role required"
}{
"detail": "Schedule not found (or backing schedule gone)"
}{
"detail": "Validation error"
}{
"detail": "Rate limit exceeded"
}{
"detail": "Schedule update failed, change rolled back — retry"
}Authorizations
APIKeyHeaderHTTPBearer
Path Parameters
Body
application/json
Response
Successful Response
A schedule. next_fire_at is computed from the cron expression
at read time (never stored) and is null only if the stored expression
cannot produce a future fire.
Available options:
success, failure, running