Scheduled Actions
Create scheduled action
Schedules a new action to be executed at a specific time
POST
/
api
/
v1
/
scheduled_actions
Create scheduled action
curl --request POST \
--url https://api.evoai.app/api/v1/scheduled_actions \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"scheduled_action": {
"action_type": "send_whatsapp",
"scheduled_for": "2025-01-15T14:30:00Z",
"payload": {
"message": "Reminder: your meeting is tomorrow!",
"phone": "+5574999999999"
},
"deal_id": "550e8400-e29b-41d4-a716-446655440000",
"contact_id": "987e6543-e21b-12d3-a456-426614174111",
"conversation_id": "111e2222-e33b-44d5-a666-777888999000",
"template_id": null,
"max_retries": 3,
"journey_session_id": null,
"recurrence_type": "once",
"recurrence_config": null
}
}
'import requests
url = "https://api.evoai.app/api/v1/scheduled_actions"
payload = { "scheduled_action": {
"action_type": "send_whatsapp",
"scheduled_for": "2025-01-15T14:30:00Z",
"payload": {
"message": "Reminder: your meeting is tomorrow!",
"phone": "+5574999999999"
},
"deal_id": "550e8400-e29b-41d4-a716-446655440000",
"contact_id": "987e6543-e21b-12d3-a456-426614174111",
"conversation_id": "111e2222-e33b-44d5-a666-777888999000",
"template_id": None,
"max_retries": 3,
"journey_session_id": None,
"recurrence_type": "once",
"recurrence_config": None
} }
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
scheduled_action: {
action_type: 'send_whatsapp',
scheduled_for: '2025-01-15T14:30:00Z',
payload: {message: 'Reminder: your meeting is tomorrow!', phone: '+5574999999999'},
deal_id: '550e8400-e29b-41d4-a716-446655440000',
contact_id: '987e6543-e21b-12d3-a456-426614174111',
conversation_id: '111e2222-e33b-44d5-a666-777888999000',
template_id: null,
max_retries: 3,
journey_session_id: null,
recurrence_type: 'once',
recurrence_config: null
}
})
};
fetch('https://api.evoai.app/api/v1/scheduled_actions', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'scheduled_action' => [
'action_type' => 'send_whatsapp',
'scheduled_for' => '2025-01-15T14:30:00Z',
'payload' => [
'message' => 'Reminder: your meeting is tomorrow!',
'phone' => '+5574999999999'
],
'deal_id' => '550e8400-e29b-41d4-a716-446655440000',
'contact_id' => '987e6543-e21b-12d3-a456-426614174111',
'conversation_id' => '111e2222-e33b-44d5-a666-777888999000',
'template_id' => null,
'max_retries' => 3,
'journey_session_id' => null,
'recurrence_type' => 'once',
'recurrence_config' => null
]
]),
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"
payload := strings.NewReader("{\n \"scheduled_action\": {\n \"action_type\": \"send_whatsapp\",\n \"scheduled_for\": \"2025-01-15T14:30:00Z\",\n \"payload\": {\n \"message\": \"Reminder: your meeting is tomorrow!\",\n \"phone\": \"+5574999999999\"\n },\n \"deal_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"contact_id\": \"987e6543-e21b-12d3-a456-426614174111\",\n \"conversation_id\": \"111e2222-e33b-44d5-a666-777888999000\",\n \"template_id\": null,\n \"max_retries\": 3,\n \"journey_session_id\": null,\n \"recurrence_type\": \"once\",\n \"recurrence_config\": null\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.evoai.app/api/v1/scheduled_actions")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"scheduled_action\": {\n \"action_type\": \"send_whatsapp\",\n \"scheduled_for\": \"2025-01-15T14:30:00Z\",\n \"payload\": {\n \"message\": \"Reminder: your meeting is tomorrow!\",\n \"phone\": \"+5574999999999\"\n },\n \"deal_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"contact_id\": \"987e6543-e21b-12d3-a456-426614174111\",\n \"conversation_id\": \"111e2222-e33b-44d5-a666-777888999000\",\n \"template_id\": null,\n \"max_retries\": 3,\n \"journey_session_id\": null,\n \"recurrence_type\": \"once\",\n \"recurrence_config\": null\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.evoai.app/api/v1/scheduled_actions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scheduled_action\": {\n \"action_type\": \"send_whatsapp\",\n \"scheduled_for\": \"2025-01-15T14:30:00Z\",\n \"payload\": {\n \"message\": \"Reminder: your meeting is tomorrow!\",\n \"phone\": \"+5574999999999\"\n },\n \"deal_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"contact_id\": \"987e6543-e21b-12d3-a456-426614174111\",\n \"conversation_id\": \"111e2222-e33b-44d5-a666-777888999000\",\n \"template_id\": null,\n \"max_retries\": 3,\n \"journey_session_id\": null,\n \"recurrence_type\": \"once\",\n \"recurrence_config\": null\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-20T14:00:00Z",
"payload": {},
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z"
},
"message": "Scheduled action created successfully"
}{
"success": false,
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request data"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/scheduled_actions",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing authentication token"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/scheduled_actions",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "You do not have permission to create scheduled actions"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/scheduled_actions",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Resource not found"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/scheduled_actions",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Validation failed",
"details": {
"scheduled_for": [
"is required"
],
"action_type": [
"is required"
]
}
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/scheduled_actions",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/scheduled_actions",
"method": "POST"
}
}Autorizaciones
Cuerpo
application/json
Show child attributes
Show child attributes
⌘I
Create scheduled action
curl --request POST \
--url https://api.evoai.app/api/v1/scheduled_actions \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"scheduled_action": {
"action_type": "send_whatsapp",
"scheduled_for": "2025-01-15T14:30:00Z",
"payload": {
"message": "Reminder: your meeting is tomorrow!",
"phone": "+5574999999999"
},
"deal_id": "550e8400-e29b-41d4-a716-446655440000",
"contact_id": "987e6543-e21b-12d3-a456-426614174111",
"conversation_id": "111e2222-e33b-44d5-a666-777888999000",
"template_id": null,
"max_retries": 3,
"journey_session_id": null,
"recurrence_type": "once",
"recurrence_config": null
}
}
'import requests
url = "https://api.evoai.app/api/v1/scheduled_actions"
payload = { "scheduled_action": {
"action_type": "send_whatsapp",
"scheduled_for": "2025-01-15T14:30:00Z",
"payload": {
"message": "Reminder: your meeting is tomorrow!",
"phone": "+5574999999999"
},
"deal_id": "550e8400-e29b-41d4-a716-446655440000",
"contact_id": "987e6543-e21b-12d3-a456-426614174111",
"conversation_id": "111e2222-e33b-44d5-a666-777888999000",
"template_id": None,
"max_retries": 3,
"journey_session_id": None,
"recurrence_type": "once",
"recurrence_config": None
} }
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
scheduled_action: {
action_type: 'send_whatsapp',
scheduled_for: '2025-01-15T14:30:00Z',
payload: {message: 'Reminder: your meeting is tomorrow!', phone: '+5574999999999'},
deal_id: '550e8400-e29b-41d4-a716-446655440000',
contact_id: '987e6543-e21b-12d3-a456-426614174111',
conversation_id: '111e2222-e33b-44d5-a666-777888999000',
template_id: null,
max_retries: 3,
journey_session_id: null,
recurrence_type: 'once',
recurrence_config: null
}
})
};
fetch('https://api.evoai.app/api/v1/scheduled_actions', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'scheduled_action' => [
'action_type' => 'send_whatsapp',
'scheduled_for' => '2025-01-15T14:30:00Z',
'payload' => [
'message' => 'Reminder: your meeting is tomorrow!',
'phone' => '+5574999999999'
],
'deal_id' => '550e8400-e29b-41d4-a716-446655440000',
'contact_id' => '987e6543-e21b-12d3-a456-426614174111',
'conversation_id' => '111e2222-e33b-44d5-a666-777888999000',
'template_id' => null,
'max_retries' => 3,
'journey_session_id' => null,
'recurrence_type' => 'once',
'recurrence_config' => null
]
]),
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"
payload := strings.NewReader("{\n \"scheduled_action\": {\n \"action_type\": \"send_whatsapp\",\n \"scheduled_for\": \"2025-01-15T14:30:00Z\",\n \"payload\": {\n \"message\": \"Reminder: your meeting is tomorrow!\",\n \"phone\": \"+5574999999999\"\n },\n \"deal_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"contact_id\": \"987e6543-e21b-12d3-a456-426614174111\",\n \"conversation_id\": \"111e2222-e33b-44d5-a666-777888999000\",\n \"template_id\": null,\n \"max_retries\": 3,\n \"journey_session_id\": null,\n \"recurrence_type\": \"once\",\n \"recurrence_config\": null\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.evoai.app/api/v1/scheduled_actions")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"scheduled_action\": {\n \"action_type\": \"send_whatsapp\",\n \"scheduled_for\": \"2025-01-15T14:30:00Z\",\n \"payload\": {\n \"message\": \"Reminder: your meeting is tomorrow!\",\n \"phone\": \"+5574999999999\"\n },\n \"deal_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"contact_id\": \"987e6543-e21b-12d3-a456-426614174111\",\n \"conversation_id\": \"111e2222-e33b-44d5-a666-777888999000\",\n \"template_id\": null,\n \"max_retries\": 3,\n \"journey_session_id\": null,\n \"recurrence_type\": \"once\",\n \"recurrence_config\": null\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.evoai.app/api/v1/scheduled_actions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scheduled_action\": {\n \"action_type\": \"send_whatsapp\",\n \"scheduled_for\": \"2025-01-15T14:30:00Z\",\n \"payload\": {\n \"message\": \"Reminder: your meeting is tomorrow!\",\n \"phone\": \"+5574999999999\"\n },\n \"deal_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"contact_id\": \"987e6543-e21b-12d3-a456-426614174111\",\n \"conversation_id\": \"111e2222-e33b-44d5-a666-777888999000\",\n \"template_id\": null,\n \"max_retries\": 3,\n \"journey_session_id\": null,\n \"recurrence_type\": \"once\",\n \"recurrence_config\": null\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-20T14:00:00Z",
"payload": {},
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z"
},
"message": "Scheduled action created successfully"
}{
"success": false,
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request data"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/scheduled_actions",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing authentication token"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/scheduled_actions",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "You do not have permission to create scheduled actions"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/scheduled_actions",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Resource not found"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/scheduled_actions",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Validation failed",
"details": {
"scheduled_for": [
"is required"
],
"action_type": [
"is required"
]
}
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/scheduled_actions",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/scheduled_actions",
"method": "POST"
}
}