Agents
Update a schedule
Changes a schedule’s name, timing, run template or overlap policy; omitted fields are left unchanged. An active schedule whose timing changed takes its next occurrence from now. Its state changes through :pause and :resume.
PATCH
/
agents
/
{agent_id}
/
schedules
/
{schedule_id}
Update a schedule
curl --request PATCH \
--url https://api.axilio.ai/api/v1/agents/{agent_id}/schedules/{schedule_id} \
--header 'Content-Type: application/json' \
--header 'X-Axilio-Api-Key: <api-key>' \
--data '
{
"cron_expression": "<string>",
"end_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"run_template": {
"revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"targets": [
{
"device_class": "phone",
"capabilities": {
"accessibility": true
},
"phone_id": "<string>",
"platform": "android"
}
],
"variables": {}
},
"start_at": "2023-11-07T05:31:56Z",
"time_zone": "<string>"
}
'import requests
url = "https://api.axilio.ai/api/v1/agents/{agent_id}/schedules/{schedule_id}"
payload = {
"cron_expression": "<string>",
"end_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"run_template": {
"revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"targets": [
{
"device_class": "phone",
"capabilities": { "accessibility": True },
"phone_id": "<string>",
"platform": "android"
}
],
"variables": {}
},
"start_at": "2023-11-07T05:31:56Z",
"time_zone": "<string>"
}
headers = {
"X-Axilio-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-Axilio-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cron_expression: '<string>',
end_at: '2023-11-07T05:31:56Z',
name: '<string>',
run_template: {
revision_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
targets: [
{
device_class: 'phone',
capabilities: {accessibility: true},
phone_id: '<string>',
platform: 'android'
}
],
variables: {}
},
start_at: '2023-11-07T05:31:56Z',
time_zone: '<string>'
})
};
fetch('https://api.axilio.ai/api/v1/agents/{agent_id}/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.axilio.ai/api/v1/agents/{agent_id}/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([
'cron_expression' => '<string>',
'end_at' => '2023-11-07T05:31:56Z',
'name' => '<string>',
'run_template' => [
'revision_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'targets' => [
[
'device_class' => 'phone',
'capabilities' => [
'accessibility' => true
],
'phone_id' => '<string>',
'platform' => 'android'
]
],
'variables' => [
]
],
'start_at' => '2023-11-07T05:31:56Z',
'time_zone' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Axilio-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.axilio.ai/api/v1/agents/{agent_id}/schedules/{schedule_id}"
payload := strings.NewReader("{\n \"cron_expression\": \"<string>\",\n \"end_at\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"run_template\": {\n \"revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"targets\": [\n {\n \"device_class\": \"phone\",\n \"capabilities\": {\n \"accessibility\": true\n },\n \"phone_id\": \"<string>\",\n \"platform\": \"android\"\n }\n ],\n \"variables\": {}\n },\n \"start_at\": \"2023-11-07T05:31:56Z\",\n \"time_zone\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Axilio-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.axilio.ai/api/v1/agents/{agent_id}/schedules/{schedule_id}")
.header("X-Axilio-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cron_expression\": \"<string>\",\n \"end_at\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"run_template\": {\n \"revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"targets\": [\n {\n \"device_class\": \"phone\",\n \"capabilities\": {\n \"accessibility\": true\n },\n \"phone_id\": \"<string>\",\n \"platform\": \"android\"\n }\n ],\n \"variables\": {}\n },\n \"start_at\": \"2023-11-07T05:31:56Z\",\n \"time_zone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.axilio.ai/api/v1/agents/{agent_id}/schedules/{schedule_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Axilio-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cron_expression\": \"<string>\",\n \"end_at\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"run_template\": {\n \"revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"targets\": [\n {\n \"device_class\": \"phone\",\n \"capabilities\": {\n \"accessibility\": true\n },\n \"phone_id\": \"<string>\",\n \"platform\": \"android\"\n }\n ],\n \"variables\": {}\n },\n \"start_at\": \"2023-11-07T05:31:56Z\",\n \"time_zone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"cron_expression": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"overlap_policy": "skip",
"run_template": {
"network": "restricted",
"revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"targets": [
{
"device_class": "phone",
"capabilities": {
"accessibility": true
},
"ownership": "dedicated",
"phone_id": "<string>",
"platform": "android"
}
],
"variables": {}
},
"state": "active",
"time_zone": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"end_at": "2023-11-07T05:31:56Z",
"last_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"next_run_at": "2023-11-07T05:31:56Z",
"start_at": "2023-11-07T05:31:56Z"
}{
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}{
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}{
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}{
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}{
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}Minimum role required: Member
Authorizations
Customer API key (axl_ prefix).
Path Parameters
The agent's id.
The schedule's id.
Body
application/json
Request body for updating a schedule. Omitted fields are left unchanged, and null clears start_at or end_at. Its state changes through :pause and :resume.
Five-field cron.
Required string length:
1 - 200No occurrence at or after this time. null clears it, so the schedule runs until deleted.
The schedule's new label.
Maximum string length:
100skip or queue.
Available options:
skip, queue What each run starts with, replaced whole.
Show child attributes
Show child attributes
No occurrence before this time. null clears it.
The IANA time zone cron_expression is read in.
Required string length:
1 - 64Response
OK
A schedule: an agent's recurring runs. Each occurrence of cron_expression, read in time_zone, starts a run with trigger scheduled and this schedule_id.
The agent the schedule runs.
When the schedule was created.
Five-field cron: minute, hour, day of month, month, day of week.
The schedule's id.
The schedule's label.
skip drops an occurrence while the schedule's previous run is scheduled, queued, running or paused. queue starts it anyway, waiting for a phone like any run.
Available options:
skip, queue What each run starts with.
Show child attributes
Show child attributes
active runs its occurrences. paused runs none until resumed. ended is final: the schedule passed its end_at.
Available options:
active, paused, ended The IANA time zone cron_expression is read in, so local times hold across daylight saving.
When the schedule was last changed.
No occurrence at or after this time. Once it passes, the schedule ends and its runs that have not started are cancelled.
The run the schedule last started.
When the next occurrence starts a run, or end_at when no occurrence is left before it. Absent unless the schedule is active.
No occurrence before this time.
⌘I
Update a schedule
curl --request PATCH \
--url https://api.axilio.ai/api/v1/agents/{agent_id}/schedules/{schedule_id} \
--header 'Content-Type: application/json' \
--header 'X-Axilio-Api-Key: <api-key>' \
--data '
{
"cron_expression": "<string>",
"end_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"run_template": {
"revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"targets": [
{
"device_class": "phone",
"capabilities": {
"accessibility": true
},
"phone_id": "<string>",
"platform": "android"
}
],
"variables": {}
},
"start_at": "2023-11-07T05:31:56Z",
"time_zone": "<string>"
}
'import requests
url = "https://api.axilio.ai/api/v1/agents/{agent_id}/schedules/{schedule_id}"
payload = {
"cron_expression": "<string>",
"end_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"run_template": {
"revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"targets": [
{
"device_class": "phone",
"capabilities": { "accessibility": True },
"phone_id": "<string>",
"platform": "android"
}
],
"variables": {}
},
"start_at": "2023-11-07T05:31:56Z",
"time_zone": "<string>"
}
headers = {
"X-Axilio-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-Axilio-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cron_expression: '<string>',
end_at: '2023-11-07T05:31:56Z',
name: '<string>',
run_template: {
revision_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
targets: [
{
device_class: 'phone',
capabilities: {accessibility: true},
phone_id: '<string>',
platform: 'android'
}
],
variables: {}
},
start_at: '2023-11-07T05:31:56Z',
time_zone: '<string>'
})
};
fetch('https://api.axilio.ai/api/v1/agents/{agent_id}/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.axilio.ai/api/v1/agents/{agent_id}/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([
'cron_expression' => '<string>',
'end_at' => '2023-11-07T05:31:56Z',
'name' => '<string>',
'run_template' => [
'revision_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'targets' => [
[
'device_class' => 'phone',
'capabilities' => [
'accessibility' => true
],
'phone_id' => '<string>',
'platform' => 'android'
]
],
'variables' => [
]
],
'start_at' => '2023-11-07T05:31:56Z',
'time_zone' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Axilio-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.axilio.ai/api/v1/agents/{agent_id}/schedules/{schedule_id}"
payload := strings.NewReader("{\n \"cron_expression\": \"<string>\",\n \"end_at\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"run_template\": {\n \"revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"targets\": [\n {\n \"device_class\": \"phone\",\n \"capabilities\": {\n \"accessibility\": true\n },\n \"phone_id\": \"<string>\",\n \"platform\": \"android\"\n }\n ],\n \"variables\": {}\n },\n \"start_at\": \"2023-11-07T05:31:56Z\",\n \"time_zone\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Axilio-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.axilio.ai/api/v1/agents/{agent_id}/schedules/{schedule_id}")
.header("X-Axilio-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cron_expression\": \"<string>\",\n \"end_at\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"run_template\": {\n \"revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"targets\": [\n {\n \"device_class\": \"phone\",\n \"capabilities\": {\n \"accessibility\": true\n },\n \"phone_id\": \"<string>\",\n \"platform\": \"android\"\n }\n ],\n \"variables\": {}\n },\n \"start_at\": \"2023-11-07T05:31:56Z\",\n \"time_zone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.axilio.ai/api/v1/agents/{agent_id}/schedules/{schedule_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Axilio-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cron_expression\": \"<string>\",\n \"end_at\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"run_template\": {\n \"revision_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"targets\": [\n {\n \"device_class\": \"phone\",\n \"capabilities\": {\n \"accessibility\": true\n },\n \"phone_id\": \"<string>\",\n \"platform\": \"android\"\n }\n ],\n \"variables\": {}\n },\n \"start_at\": \"2023-11-07T05:31:56Z\",\n \"time_zone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"cron_expression": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"overlap_policy": "skip",
"run_template": {
"network": "restricted",
"revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"targets": [
{
"device_class": "phone",
"capabilities": {
"accessibility": true
},
"ownership": "dedicated",
"phone_id": "<string>",
"platform": "android"
}
],
"variables": {}
},
"state": "active",
"time_zone": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"end_at": "2023-11-07T05:31:56Z",
"last_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"next_run_at": "2023-11-07T05:31:56Z",
"start_at": "2023-11-07T05:31:56Z"
}{
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}{
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}{
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}{
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}{
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}