Update workflow
curl --request PUT \
--url https://api.example.com/v1/workflows/{workflow_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"project_id": "<string>",
"title": "<string>",
"expected_revision": 1,
"description": "",
"output_folder": "",
"graph": {},
"triggers": [
{
"schedule": {
"zone_id": "<string>",
"time_of_day": "09:00",
"run_date": "2023-12-25",
"days_of_week": [],
"day_of_month": 16,
"interval": 1
},
"id": "",
"type": "schedule",
"label": "",
"enabled": true,
"params": {}
}
]
}
'import requests
url = "https://api.example.com/v1/workflows/{workflow_id}"
payload = {
"project_id": "<string>",
"title": "<string>",
"expected_revision": 1,
"description": "",
"output_folder": "",
"graph": {},
"triggers": [
{
"schedule": {
"zone_id": "<string>",
"time_of_day": "09:00",
"run_date": "2023-12-25",
"days_of_week": [],
"day_of_month": 16,
"interval": 1
},
"id": "",
"type": "schedule",
"label": "",
"enabled": True,
"params": {}
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
project_id: '<string>',
title: '<string>',
expected_revision: 1,
description: '',
output_folder: '',
graph: {},
triggers: [
{
schedule: {
zone_id: '<string>',
time_of_day: '09:00',
run_date: '2023-12-25',
days_of_week: [],
day_of_month: 16,
interval: 1
},
id: '',
type: 'schedule',
label: '',
enabled: true,
params: {}
}
]
})
};
fetch('https://api.example.com/v1/workflows/{workflow_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.example.com/v1/workflows/{workflow_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'project_id' => '<string>',
'title' => '<string>',
'expected_revision' => 1,
'description' => '',
'output_folder' => '',
'graph' => [
],
'triggers' => [
[
'schedule' => [
'zone_id' => '<string>',
'time_of_day' => '09:00',
'run_date' => '2023-12-25',
'days_of_week' => [
],
'day_of_month' => 16,
'interval' => 1
],
'id' => '',
'type' => 'schedule',
'label' => '',
'enabled' => true,
'params' => [
]
]
]
]),
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.example.com/v1/workflows/{workflow_id}"
payload := strings.NewReader("{\n \"project_id\": \"<string>\",\n \"title\": \"<string>\",\n \"expected_revision\": 1,\n \"description\": \"\",\n \"output_folder\": \"\",\n \"graph\": {},\n \"triggers\": [\n {\n \"schedule\": {\n \"zone_id\": \"<string>\",\n \"time_of_day\": \"09:00\",\n \"run_date\": \"2023-12-25\",\n \"days_of_week\": [],\n \"day_of_month\": 16,\n \"interval\": 1\n },\n \"id\": \"\",\n \"type\": \"schedule\",\n \"label\": \"\",\n \"enabled\": true,\n \"params\": {}\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.example.com/v1/workflows/{workflow_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"project_id\": \"<string>\",\n \"title\": \"<string>\",\n \"expected_revision\": 1,\n \"description\": \"\",\n \"output_folder\": \"\",\n \"graph\": {},\n \"triggers\": [\n {\n \"schedule\": {\n \"zone_id\": \"<string>\",\n \"time_of_day\": \"09:00\",\n \"run_date\": \"2023-12-25\",\n \"days_of_week\": [],\n \"day_of_month\": 16,\n \"interval\": 1\n },\n \"id\": \"\",\n \"type\": \"schedule\",\n \"label\": \"\",\n \"enabled\": true,\n \"params\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/workflows/{workflow_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"project_id\": \"<string>\",\n \"title\": \"<string>\",\n \"expected_revision\": 1,\n \"description\": \"\",\n \"output_folder\": \"\",\n \"graph\": {},\n \"triggers\": [\n {\n \"schedule\": {\n \"zone_id\": \"<string>\",\n \"time_of_day\": \"09:00\",\n \"run_date\": \"2023-12-25\",\n \"days_of_week\": [],\n \"day_of_month\": 16,\n \"interval\": 1\n },\n \"id\": \"\",\n \"type\": \"schedule\",\n \"label\": \"\",\n \"enabled\": true,\n \"params\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"projectId": "<string>",
"title": "<string>",
"description": "<string>",
"ownerUserId": "<string>",
"status": "<string>",
"executionFormat": "<string>",
"outputFolder": "<string>",
"revision": 123,
"activeVersionId": "<string>",
"triggers": [
{
"id": "<string>",
"type": "<string>",
"label": "<string>",
"enabled": true,
"params": {},
"schedule": {
"type": "<string>",
"zoneId": "<string>",
"cronExpression": "<string>",
"everyMinutes": 123,
"timeOfDay": "<string>",
"runDate": "<string>",
"anchorDate": "<string>",
"daysOfWeek": [
"<string>"
],
"dayOfMonth": 123,
"interval": 123
}
}
],
"steps": [
{
"id": "<string>",
"position": 123,
"type": "<string>",
"targetFileId": "<string>",
"config": {},
"targets": [
{
"kind": "email_to",
"value": "<string>",
"displayName": "<string>"
}
]
}
],
"graph": {},
"createdAt": "<string>",
"updatedAt": "<string>"
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}Workflows
Update workflow
Replace a workflow’s editable state. The request is the complete desired state: triggers it omits are deleted, and a graph it omits is left untouched. Editing changes what the next activation would run, never what an active schedule is running now.
PUT
/
v1
/
workflows
/
{workflow_id}
Update workflow
curl --request PUT \
--url https://api.example.com/v1/workflows/{workflow_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"project_id": "<string>",
"title": "<string>",
"expected_revision": 1,
"description": "",
"output_folder": "",
"graph": {},
"triggers": [
{
"schedule": {
"zone_id": "<string>",
"time_of_day": "09:00",
"run_date": "2023-12-25",
"days_of_week": [],
"day_of_month": 16,
"interval": 1
},
"id": "",
"type": "schedule",
"label": "",
"enabled": true,
"params": {}
}
]
}
'import requests
url = "https://api.example.com/v1/workflows/{workflow_id}"
payload = {
"project_id": "<string>",
"title": "<string>",
"expected_revision": 1,
"description": "",
"output_folder": "",
"graph": {},
"triggers": [
{
"schedule": {
"zone_id": "<string>",
"time_of_day": "09:00",
"run_date": "2023-12-25",
"days_of_week": [],
"day_of_month": 16,
"interval": 1
},
"id": "",
"type": "schedule",
"label": "",
"enabled": True,
"params": {}
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
project_id: '<string>',
title: '<string>',
expected_revision: 1,
description: '',
output_folder: '',
graph: {},
triggers: [
{
schedule: {
zone_id: '<string>',
time_of_day: '09:00',
run_date: '2023-12-25',
days_of_week: [],
day_of_month: 16,
interval: 1
},
id: '',
type: 'schedule',
label: '',
enabled: true,
params: {}
}
]
})
};
fetch('https://api.example.com/v1/workflows/{workflow_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.example.com/v1/workflows/{workflow_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'project_id' => '<string>',
'title' => '<string>',
'expected_revision' => 1,
'description' => '',
'output_folder' => '',
'graph' => [
],
'triggers' => [
[
'schedule' => [
'zone_id' => '<string>',
'time_of_day' => '09:00',
'run_date' => '2023-12-25',
'days_of_week' => [
],
'day_of_month' => 16,
'interval' => 1
],
'id' => '',
'type' => 'schedule',
'label' => '',
'enabled' => true,
'params' => [
]
]
]
]),
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.example.com/v1/workflows/{workflow_id}"
payload := strings.NewReader("{\n \"project_id\": \"<string>\",\n \"title\": \"<string>\",\n \"expected_revision\": 1,\n \"description\": \"\",\n \"output_folder\": \"\",\n \"graph\": {},\n \"triggers\": [\n {\n \"schedule\": {\n \"zone_id\": \"<string>\",\n \"time_of_day\": \"09:00\",\n \"run_date\": \"2023-12-25\",\n \"days_of_week\": [],\n \"day_of_month\": 16,\n \"interval\": 1\n },\n \"id\": \"\",\n \"type\": \"schedule\",\n \"label\": \"\",\n \"enabled\": true,\n \"params\": {}\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.example.com/v1/workflows/{workflow_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"project_id\": \"<string>\",\n \"title\": \"<string>\",\n \"expected_revision\": 1,\n \"description\": \"\",\n \"output_folder\": \"\",\n \"graph\": {},\n \"triggers\": [\n {\n \"schedule\": {\n \"zone_id\": \"<string>\",\n \"time_of_day\": \"09:00\",\n \"run_date\": \"2023-12-25\",\n \"days_of_week\": [],\n \"day_of_month\": 16,\n \"interval\": 1\n },\n \"id\": \"\",\n \"type\": \"schedule\",\n \"label\": \"\",\n \"enabled\": true,\n \"params\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/workflows/{workflow_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"project_id\": \"<string>\",\n \"title\": \"<string>\",\n \"expected_revision\": 1,\n \"description\": \"\",\n \"output_folder\": \"\",\n \"graph\": {},\n \"triggers\": [\n {\n \"schedule\": {\n \"zone_id\": \"<string>\",\n \"time_of_day\": \"09:00\",\n \"run_date\": \"2023-12-25\",\n \"days_of_week\": [],\n \"day_of_month\": 16,\n \"interval\": 1\n },\n \"id\": \"\",\n \"type\": \"schedule\",\n \"label\": \"\",\n \"enabled\": true,\n \"params\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"projectId": "<string>",
"title": "<string>",
"description": "<string>",
"ownerUserId": "<string>",
"status": "<string>",
"executionFormat": "<string>",
"outputFolder": "<string>",
"revision": 123,
"activeVersionId": "<string>",
"triggers": [
{
"id": "<string>",
"type": "<string>",
"label": "<string>",
"enabled": true,
"params": {},
"schedule": {
"type": "<string>",
"zoneId": "<string>",
"cronExpression": "<string>",
"everyMinutes": 123,
"timeOfDay": "<string>",
"runDate": "<string>",
"anchorDate": "<string>",
"daysOfWeek": [
"<string>"
],
"dayOfMonth": 123,
"interval": 123
}
}
],
"steps": [
{
"id": "<string>",
"position": 123,
"type": "<string>",
"targetFileId": "<string>",
"config": {},
"targets": [
{
"kind": "email_to",
"value": "<string>",
"displayName": "<string>"
}
]
}
],
"graph": {},
"createdAt": "<string>",
"updatedAt": "<string>"
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Body
application/json
A full replacement of a workflow's editable state.
Editing a workflow changes what the NEXT activation would run, never what an already active schedule is running.
This is the read-modify-write half of the surface, so it takes a workflow exactly as a GET
renders it, plus expected_revision: the fields a workflow reports but does not let you
set — its id, owner, execution format, revision, active version, run steps and timestamps —
are dropped rather than refused. Anything else it does not recognise is still a 422, so a
misspelled field cannot silently skip part of the change.
status is the one field that is writable AND readable with a value the write half cannot
mint, so it is accepted as an echo rather than dropped: see its description and
update_workflow.
Project the workflow belongs to. You must have editor access to it.
Minimum string length:
1Workflow name, shown wherever it is listed.
Required string length:
1 - 255The revision you last read. The update is applied only if the workflow is still at that revision; otherwise nothing changes and the request conflicts. This is what stops a stale client deleting another client's triggers.
Required range:
x >= 0Optional longer description.
Maximum string length:
2000New workflow state. Omit to leave it unchanged. active is accepted only as an echo: an already active workflow can be handed back exactly as it reads, and the update leaves it active. It cannot be used to ACTIVATE a workflow — that is the activate operation, which freezes the version that runs — so asking for active on a workflow that is not already active is refused.
Available options:
draft, active, paused, archived Project folder the workflow writes its outputs to, for example /Reports.
Maximum string length:
512Replacement graph document, in the same shape and with the same trigger and edge rules as on create: send the full desired document, since what you send replaces the stored graph rather than merging into it. Omit to leave the stored graph untouched. Serializes to at most 200000 characters.
Schedules that start this workflow. Omit for a workflow that only runs on demand. These rows and the graph's trigger nodes must agree: a schedule here requires a summation.trigger.schedule/v1 node in the graph — it is the node the schedule's parameter values are bound to — and that node requires a schedule here, or nothing would fire it. A request where the two disagree is refused.
Maximum array length:
20Show child attributes
Show child attributes
Response
Successful Response
Show child attributes
Show child attributes