Create a scheduled task
curl --request POST \
--url https://api.langdock.com/automations/v1 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"prompt": "<string>",
"timeOfDay": "<string>",
"dayOfWeek": 3,
"dayOfMonth": 16,
"daysOfWeek": [
3
],
"timezone": "<string>",
"modelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assistantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"taggedAssistantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"taggedIntegrationIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"taggedKnowledgeFolderIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"taggedWorkflowIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"taggedSkillSlugs": [
"<string>"
],
"attachmentIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'import requests
url = "https://api.langdock.com/automations/v1"
payload = {
"name": "<string>",
"prompt": "<string>",
"timeOfDay": "<string>",
"dayOfWeek": 3,
"dayOfMonth": 16,
"daysOfWeek": [3],
"timezone": "<string>",
"modelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assistantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"taggedAssistantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"taggedIntegrationIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"taggedKnowledgeFolderIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"taggedWorkflowIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"taggedSkillSlugs": ["<string>"],
"attachmentIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
prompt: '<string>',
timeOfDay: '<string>',
dayOfWeek: 3,
dayOfMonth: 16,
daysOfWeek: [3],
timezone: '<string>',
modelId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
assistantId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
taggedAssistantId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
taggedIntegrationIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
taggedKnowledgeFolderIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
taggedWorkflowIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
taggedSkillSlugs: ['<string>'],
attachmentIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
})
};
fetch('https://api.langdock.com/automations/v1', 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.langdock.com/automations/v1",
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([
'name' => '<string>',
'prompt' => '<string>',
'timeOfDay' => '<string>',
'dayOfWeek' => 3,
'dayOfMonth' => 16,
'daysOfWeek' => [
3
],
'timezone' => '<string>',
'modelId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'assistantId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'taggedAssistantId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'taggedIntegrationIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'taggedKnowledgeFolderIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'taggedWorkflowIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'taggedSkillSlugs' => [
'<string>'
],
'attachmentIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.langdock.com/automations/v1"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"timeOfDay\": \"<string>\",\n \"dayOfWeek\": 3,\n \"dayOfMonth\": 16,\n \"daysOfWeek\": [\n 3\n ],\n \"timezone\": \"<string>\",\n \"modelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assistantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"taggedAssistantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"taggedIntegrationIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"taggedKnowledgeFolderIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"taggedWorkflowIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"taggedSkillSlugs\": [\n \"<string>\"\n ],\n \"attachmentIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.langdock.com/automations/v1")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"timeOfDay\": \"<string>\",\n \"dayOfWeek\": 3,\n \"dayOfMonth\": 16,\n \"daysOfWeek\": [\n 3\n ],\n \"timezone\": \"<string>\",\n \"modelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assistantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"taggedAssistantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"taggedIntegrationIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"taggedKnowledgeFolderIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"taggedWorkflowIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"taggedSkillSlugs\": [\n \"<string>\"\n ],\n \"attachmentIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.langdock.com/automations/v1")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"timeOfDay\": \"<string>\",\n \"dayOfWeek\": 3,\n \"dayOfMonth\": 16,\n \"daysOfWeek\": [\n 3\n ],\n \"timezone\": \"<string>\",\n \"modelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assistantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"taggedAssistantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"taggedIntegrationIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"taggedKnowledgeFolderIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"taggedWorkflowIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"taggedSkillSlugs\": [\n \"<string>\"\n ],\n \"attachmentIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}"
response = http.request(request)
puts response.read_bodyScheduled Tasks API
Create Scheduled Task
Create a scheduled task owned by the workspace API key
POST
/
automations
/
v1
Create a scheduled task
curl --request POST \
--url https://api.langdock.com/automations/v1 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"prompt": "<string>",
"timeOfDay": "<string>",
"dayOfWeek": 3,
"dayOfMonth": 16,
"daysOfWeek": [
3
],
"timezone": "<string>",
"modelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assistantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"taggedAssistantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"taggedIntegrationIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"taggedKnowledgeFolderIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"taggedWorkflowIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"taggedSkillSlugs": [
"<string>"
],
"attachmentIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'import requests
url = "https://api.langdock.com/automations/v1"
payload = {
"name": "<string>",
"prompt": "<string>",
"timeOfDay": "<string>",
"dayOfWeek": 3,
"dayOfMonth": 16,
"daysOfWeek": [3],
"timezone": "<string>",
"modelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assistantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"taggedAssistantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"taggedIntegrationIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"taggedKnowledgeFolderIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"taggedWorkflowIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"taggedSkillSlugs": ["<string>"],
"attachmentIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
prompt: '<string>',
timeOfDay: '<string>',
dayOfWeek: 3,
dayOfMonth: 16,
daysOfWeek: [3],
timezone: '<string>',
modelId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
assistantId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
taggedAssistantId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
taggedIntegrationIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
taggedKnowledgeFolderIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
taggedWorkflowIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
taggedSkillSlugs: ['<string>'],
attachmentIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
})
};
fetch('https://api.langdock.com/automations/v1', 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.langdock.com/automations/v1",
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([
'name' => '<string>',
'prompt' => '<string>',
'timeOfDay' => '<string>',
'dayOfWeek' => 3,
'dayOfMonth' => 16,
'daysOfWeek' => [
3
],
'timezone' => '<string>',
'modelId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'assistantId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'taggedAssistantId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'taggedIntegrationIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'taggedKnowledgeFolderIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'taggedWorkflowIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'taggedSkillSlugs' => [
'<string>'
],
'attachmentIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.langdock.com/automations/v1"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"timeOfDay\": \"<string>\",\n \"dayOfWeek\": 3,\n \"dayOfMonth\": 16,\n \"daysOfWeek\": [\n 3\n ],\n \"timezone\": \"<string>\",\n \"modelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assistantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"taggedAssistantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"taggedIntegrationIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"taggedKnowledgeFolderIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"taggedWorkflowIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"taggedSkillSlugs\": [\n \"<string>\"\n ],\n \"attachmentIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.langdock.com/automations/v1")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"timeOfDay\": \"<string>\",\n \"dayOfWeek\": 3,\n \"dayOfMonth\": 16,\n \"daysOfWeek\": [\n 3\n ],\n \"timezone\": \"<string>\",\n \"modelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assistantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"taggedAssistantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"taggedIntegrationIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"taggedKnowledgeFolderIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"taggedWorkflowIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"taggedSkillSlugs\": [\n \"<string>\"\n ],\n \"attachmentIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.langdock.com/automations/v1")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"timeOfDay\": \"<string>\",\n \"dayOfWeek\": 3,\n \"dayOfMonth\": 16,\n \"daysOfWeek\": [\n 3\n ],\n \"timezone\": \"<string>\",\n \"modelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assistantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"taggedAssistantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"taggedIntegrationIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"taggedKnowledgeFolderIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"taggedWorkflowIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"taggedSkillSlugs\": [\n \"<string>\"\n ],\n \"attachmentIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}"
response = http.request(request)
puts response.read_bodyCreates a scheduled task owned by this workspace API key. New tasks start with
An invalid body returns
active set to true. The response status is 201. The body does not include runCount.
Base URL
https://api.langdock.com/automations/v1
Dedicated deploymentsReplace
api.langdock.com with <your-deployment-url>/api/public in all requests.Required scopes
This endpoint requires theAUTOMATION_API scope (Scheduled Tasks API) on a workspace API key.
A workspace can hold 10 tasks for this owner. The next create returns 400 with AUTOMATION_LIMIT_REACHED. An expired trial returns 403 with TRIAL_EXPIRED.
Parameters
Send a JSON body. Unknown fields are rejected. Schedule rules are on the Scheduled Tasks API Overview.| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | 1 to 200 characters. |
prompt | string | Yes | 1 to 120000 characters. |
frequency | string | Yes | MANUAL, DAILY, WEEKDAYS, WEEKLY, MONTHLY, or SELECTED_WEEKDAYS. |
timeOfDay | string | For every frequency except MANUAL | 24 hour HH:mm. |
dayOfWeek | integer | For WEEKLY | 0 (Sunday) through 6 (Saturday). |
dayOfMonth | integer | For MONTHLY | 1 through 31. |
daysOfWeek | integer[] | For SELECTED_WEEKDAYS | At least one day, each 0 through 6. At most 7 values. |
timezone | string | null | No | IANA name, at most 64 characters. Empty or omitted on a scheduled frequency is stored as UTC. |
modelMode | string | No | UNSET, EXPLICIT, or AUTO. |
modelId | string | null | When modelMode is EXPLICIT | Model UUID. Must be in the same request. |
assistantId | string | null | No | Primary agent UUID. Must be available to the key. |
taggedAssistantId | string | null | No | Extra agent mention. Dropped when the key cannot use it. |
taggedIntegrationIds | string[] | No | At most 20. Inaccessible ids are dropped. |
taggedKnowledgeFolderIds | string[] | No | At most 20. Inaccessible ids are dropped. |
taggedWorkflowIds | string[] | No | At most 20. Inaccessible ids are dropped. |
taggedSkillSlugs | string[] | No | At most 20. Each slug is at most 100 characters. Inaccessible slugs are dropped. |
attachmentIds | string[] | No | At most 20 attachment UUIDs already owned by this key in the workspace. |
Example
const axios = require("axios");
async function createScheduledTask() {
const response = await axios.post(
"https://api.langdock.com/automations/v1",
{
name: "Monday pipeline brief",
prompt: "Summarize overnight pipeline changes for the revenue team.",
frequency: "WEEKLY",
timeOfDay: "09:00",
dayOfWeek: 1,
timezone: "Europe/Berlin"
},
{
headers: {
Authorization: "Bearer YOUR_API_KEY",
"Content-Type": "application/json"
}
}
);
console.log(response.status, response.data.automation.id);
}
createScheduledTask();
Response format
Success response (201 Created)
automation matches the scheduled task object without runCount.
{
automation: {
id: string;
createdAt: string;
name: string;
prompt: string;
modelId: string | null;
modelMode: "UNSET" | "EXPLICIT" | "AUTO";
assistantId: string | null;
taggedAssistantId: string | null;
frequency:
| "MANUAL"
| "DAILY"
| "WEEKDAYS"
| "WEEKLY"
| "MONTHLY"
| "SELECTED_WEEKDAYS";
timeOfDay: string | null;
dayOfWeek: number | null;
dayOfMonth: number | null;
daysOfWeek: number[];
timezone: string | null;
active: boolean;
lastRunAt: string | null;
attachments: Array<{
id: string;
name: string;
mimeType: string | null;
type: string | null;
}>;
taggedIntegrationIds: string[];
taggedKnowledgeFolderIds: string[];
taggedWorkflowIds: string[];
taggedSkillSlugs: string[];
};
}
Error handling
| Status code | Description |
|---|---|
| 400 | Invalid body, or message AUTOMATION_LIMIT_REACHED |
| 401 | Invalid or missing API key, or the key user was not found |
| 403 | Missing AUTOMATION_API, a personal API key, Scheduled Tasks disabled, no product access, TRIAL_EXPIRED, or AUTOMATION_TAG_ACCESS_DENIED |
| 405 | Method not allowed |
| 429 | Rate limit exceeded |
| 500 | Internal server error |
400 with message Invalid request and an errors array. Missing clock fields use timeOfDay is required for scheduled automations, dayOfWeek is required for weekly automations, dayOfMonth is required for monthly automations, or daysOfWeek is required for selected weekday automations. An invalid timezone uses timezone must be a valid IANA identifier. modelMode EXPLICIT without modelId uses modelId is required for explicit model selection. An expired trial returns 403 with code TRIAL_EXPIRED and message Your trial has expired. Upgrade to continue.
Langdock intentionally blocks browser-origin requests to protect your API key and ensure your applications remain secure. For more information, please see our guide on API Key Best Practices.
Authorizations
API key as Bearer token. Format "Bearer YOUR_API_KEY"
Body
application/json
Required string length:
1 - 200Required string length:
1 - 120000Available options:
MANUAL, DAILY, WEEKDAYS, WEEKLY, MONTHLY, SELECTED_WEEKDAYS 24 hour HH:mm. Required unless frequency is MANUAL.
Required for WEEKLY. 0 is Sunday and 6 is Saturday.
Required range:
0 <= x <= 6Required for MONTHLY.
Required range:
1 <= x <= 31Required for SELECTED_WEEKDAYS.
Maximum array length:
7Required range:
0 <= x <= 6IANA timezone. Empty or omitted on a scheduled frequency is stored as UTC.
Maximum string length:
64Available options:
UNSET, EXPLICIT, AUTO Required in the same request when modelMode is EXPLICIT.
Maximum array length:
20Maximum array length:
20Maximum array length:
20Maximum array length:
20Maximum string length:
100Maximum array length:
20Response
Scheduled task created. The automation object does not include runCount.
Was this page helpful?