Skip to main content
PATCH
/
v1
/
agents
/
{agent_id}
/
scheduled-tasks
/
{task_id}
Update Scheduled Task
curl --request PATCH \
  --url https://api.xpander.ai/v1/agents/{agent_id}/scheduled-tasks/{task_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "cron": "<string>",
  "prompt": "<string>",
  "title": "<string>",
  "enabled": true
}
'
import requests

url = "https://api.xpander.ai/v1/agents/{agent_id}/scheduled-tasks/{task_id}"

payload = {
    "cron": "<string>",
    "prompt": "<string>",
    "title": "<string>",
    "enabled": True
}
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: '<string>', prompt: '<string>', title: '<string>', enabled: true})
};

fetch('https://api.xpander.ai/v1/agents/{agent_id}/scheduled-tasks/{task_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.xpander.ai/v1/agents/{agent_id}/scheduled-tasks/{task_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' => '<string>',
    'prompt' => '<string>',
    'title' => '<string>',
    'enabled' => true
  ]),
  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.xpander.ai/v1/agents/{agent_id}/scheduled-tasks/{task_id}"

	payload := strings.NewReader("{\n  \"cron\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"title\": \"<string>\",\n  \"enabled\": true\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.xpander.ai/v1/agents/{agent_id}/scheduled-tasks/{task_id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cron\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"title\": \"<string>\",\n  \"enabled\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.xpander.ai/v1/agents/{agent_id}/scheduled-tasks/{task_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\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"title\": \"<string>\",\n  \"enabled\": true\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "cron": "<string>",
  "prompt": "<string>",
  "title": "<string>",
  "enabled": true
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}
Update any subset of a scheduled task’s fields. Set enabled: false to pause a task without losing its config; set enabled: true to resume. Changes take effect immediately.

​
Request Body

​
cron
string
New cron expression (5-field crontab, UTC).
​
prompt
string
New instruction.
​
title
string
New label.
​
enabled
boolean
Pause (false) or resume (true) without losing config.

​
Example Request

# Pause a task
curl -X PATCH -H "x-api-key: <your-api-key>" -H "Content-Type: application/json" \
  "https://api.xpander.ai/v1/agents/<agent-id>/scheduled-tasks/<task-id>" \
  -d '{ "enabled": false }'

​
Example Response

{
  "id": "<task-id>",
  "title": "Daily ticket digest",
  "cron": "0 9 * * *",
  "prompt": "Summarize yesterday's support tickets and post to #ops.",
  "enabled": false
}

Authorizations

​
x-api-key
string
header
required

API Key for authentication

Path Parameters

​
agent_id
string
required
​
task_id
string
required

Body

application/json

Update a recurring scheduled task. Only provided fields change.

​
cron
string | null

New cron expression.

​
prompt
string | null

New instruction.

​
title
string | null

New label.

​
enabled
boolean | null

Pause (false) or resume (true) without losing config.

Response

Successful Response

A recurring scheduled task — the simplified view of one cron task source node.

​
id
string
required

Source-node id. Pass it to update/remove/run the task.

​
cron
string
required

Cron expression (5-field crontab, UTC), e.g. '0 9 * * *'.

​
prompt
string
required

Instruction the agent runs on each fire.

​
title
string | null

Human-readable label for the task.

​
enabled
boolean
default:true

Whether the task is active. Disabled tasks keep their config but do not fire.