API Reference
- Calls
- Agents
- Metrics
- Evaluators
- Results
- Runs
- Personalities
- Predefined Metrics
- Phone Numbers
- Schedules
Schedules
Creating a Schedule Job
Create a new scheduled job
POST
/
schedules
/
v1
/
cron-jobs-external
/
Copy
Ask AI
curl --request POST \
--url https://new-prod.vocera.ai/schedules/v1/cron-jobs-external/ \
--header 'Content-Type: application/json' \
--header 'X-VOCERA-API-KEY: <api-key>' \
--data '{
"name": "<string>",
"scenarios": [
123
],
"tags": [
"<string>"
],
"agent": 123,
"crontab_expression": "<string>"
}'
Copy
Ask AI
{
"id": 123,
"agent": 123,
"name": "<string>",
"crontab_expression": "<string>",
"timezone": "<string>",
"scenario_ids": [
123
],
"scenarios_data": [
{
"id": 123,
"agent": 123,
"name": "<string>",
"personality": 123,
"personality_name": "<string>"
}
],
"tags": [
"<string>"
],
"frequency": 50,
"notify_on": "never"
}
Authorizations
API Key Authentication. It should be included in the header of each request.
Body
Response
201 - application/json
The response is of type object
.
Copy
Ask AI
curl --request POST \
--url https://new-prod.vocera.ai/schedules/v1/cron-jobs-external/ \
--header 'Content-Type: application/json' \
--header 'X-VOCERA-API-KEY: <api-key>' \
--data '{
"name": "<string>",
"scenarios": [
123
],
"tags": [
"<string>"
],
"agent": 123,
"crontab_expression": "<string>"
}'
Copy
Ask AI
{
"id": 123,
"agent": 123,
"name": "<string>",
"crontab_expression": "<string>",
"timezone": "<string>",
"scenario_ids": [
123
],
"scenarios_data": [
{
"id": 123,
"agent": 123,
"name": "<string>",
"personality": 123,
"personality_name": "<string>"
}
],
"tags": [
"<string>"
],
"frequency": 50,
"notify_on": "never"
}
Assistant
Responses are generated using AI and may contain mistakes.