Scheduled Actions
Update scheduled action
Updates properties of a scheduled action (only for actions with ‘scheduled’ status). Allows changing time, payload and recurrence settings.
PATCH
/
api
/
v1
/
scheduled_actions
/
{id}
Update scheduled action
curl --request PATCH \
--url https://api.evoai.app/api/v1/scheduled_actions/{id} \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"scheduled_action": {
"scheduled_for": "2025-01-16T10:00:00Z",
"max_retries": 5,
"payload": {},
"recurrence_config": {}
}
}
'import requests
url = "https://api.evoai.app/api/v1/scheduled_actions/{id}"
payload = { "scheduled_action": {
"scheduled_for": "2025-01-16T10:00:00Z",
"max_retries": 5,
"payload": {},
"recurrence_config": {}
} }
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
scheduled_action: {
scheduled_for: '2025-01-16T10:00:00Z',
max_retries: 5,
payload: {},
recurrence_config: {}
}
})
};
fetch('https://api.evoai.app/api/v1/scheduled_actions/{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.evoai.app/api/v1/scheduled_actions/{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([
'scheduled_action' => [
'scheduled_for' => '2025-01-16T10:00:00Z',
'max_retries' => 5,
'payload' => [
],
'recurrence_config' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_access_token: <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.evoai.app/api/v1/scheduled_actions/{id}"
payload := strings.NewReader("{\n \"scheduled_action\": {\n \"scheduled_for\": \"2025-01-16T10:00:00Z\",\n \"max_retries\": 5,\n \"payload\": {},\n \"recurrence_config\": {}\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("api_access_token", "<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.evoai.app/api/v1/scheduled_actions/{id}")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"scheduled_action\": {\n \"scheduled_for\": \"2025-01-16T10:00:00Z\",\n \"max_retries\": 5,\n \"payload\": {},\n \"recurrence_config\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.evoai.app/api/v1/scheduled_actions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scheduled_action\": {\n \"scheduled_for\": \"2025-01-16T10:00:00Z\",\n \"max_retries\": 5,\n \"payload\": {},\n \"recurrence_config\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "dd0e8400-e29b-41d4-a716-446655440008",
"action_type": "send_message",
"status": "scheduled",
"scheduled_at": "2024-01-25T14:00:00Z",
"payload": {},
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:35:00Z"
},
"meta": {
"timestamp": "2024-01-15T10:35:00Z"
},
"message": "Scheduled action updated successfully"
}{
"success": false,
"error": {
"code": "BAD_REQUEST",
"message": "Cannot update action that is not scheduled"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/scheduled_actions/{id}",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing authentication token"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/scheduled_actions/{id}",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "You do not have permission to update this scheduled action"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/scheduled_actions/{id}",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Scheduled action not found"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/scheduled_actions/{id}",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Validation failed",
"details": {
"scheduled_for": [
"must be a future date"
]
}
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/scheduled_actions/{id}",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/scheduled_actions/{id}",
"method": "PATCH"
}
}Autorizaciones
Parámetros de ruta
Scheduled action ID
Cuerpo
application/json
Show child attributes
Show child attributes
⌘I
Update scheduled action
curl --request PATCH \
--url https://api.evoai.app/api/v1/scheduled_actions/{id} \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"scheduled_action": {
"scheduled_for": "2025-01-16T10:00:00Z",
"max_retries": 5,
"payload": {},
"recurrence_config": {}
}
}
'import requests
url = "https://api.evoai.app/api/v1/scheduled_actions/{id}"
payload = { "scheduled_action": {
"scheduled_for": "2025-01-16T10:00:00Z",
"max_retries": 5,
"payload": {},
"recurrence_config": {}
} }
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
scheduled_action: {
scheduled_for: '2025-01-16T10:00:00Z',
max_retries: 5,
payload: {},
recurrence_config: {}
}
})
};
fetch('https://api.evoai.app/api/v1/scheduled_actions/{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.evoai.app/api/v1/scheduled_actions/{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([
'scheduled_action' => [
'scheduled_for' => '2025-01-16T10:00:00Z',
'max_retries' => 5,
'payload' => [
],
'recurrence_config' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_access_token: <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.evoai.app/api/v1/scheduled_actions/{id}"
payload := strings.NewReader("{\n \"scheduled_action\": {\n \"scheduled_for\": \"2025-01-16T10:00:00Z\",\n \"max_retries\": 5,\n \"payload\": {},\n \"recurrence_config\": {}\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("api_access_token", "<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.evoai.app/api/v1/scheduled_actions/{id}")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"scheduled_action\": {\n \"scheduled_for\": \"2025-01-16T10:00:00Z\",\n \"max_retries\": 5,\n \"payload\": {},\n \"recurrence_config\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.evoai.app/api/v1/scheduled_actions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scheduled_action\": {\n \"scheduled_for\": \"2025-01-16T10:00:00Z\",\n \"max_retries\": 5,\n \"payload\": {},\n \"recurrence_config\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "dd0e8400-e29b-41d4-a716-446655440008",
"action_type": "send_message",
"status": "scheduled",
"scheduled_at": "2024-01-25T14:00:00Z",
"payload": {},
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:35:00Z"
},
"meta": {
"timestamp": "2024-01-15T10:35:00Z"
},
"message": "Scheduled action updated successfully"
}{
"success": false,
"error": {
"code": "BAD_REQUEST",
"message": "Cannot update action that is not scheduled"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/scheduled_actions/{id}",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing authentication token"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/scheduled_actions/{id}",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "You do not have permission to update this scheduled action"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/scheduled_actions/{id}",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Scheduled action not found"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/scheduled_actions/{id}",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Validation failed",
"details": {
"scheduled_for": [
"must be a future date"
]
}
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/scheduled_actions/{id}",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/scheduled_actions/{id}",
"method": "PATCH"
}
}