[Beta] Update a workflow draft in place when possible
curl --request PATCH \
--url http://localhost:8080/workflows/{workflow_id}/draft \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"trigger_configuration": "<unknown>",
"workflow_blocks": [
"<unknown>"
],
"workflow_editor_state": "<unknown>"
}
'import requests
url = "http://localhost:8080/workflows/{workflow_id}/draft"
payload = {
"name": "<string>",
"description": "<string>",
"trigger_configuration": "<unknown>",
"workflow_blocks": ["<unknown>"],
"workflow_editor_state": "<unknown>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
trigger_configuration: '<unknown>',
workflow_blocks: ['<unknown>'],
workflow_editor_state: '<unknown>'
})
};
fetch('http://localhost:8080/workflows/{workflow_id}/draft', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/workflows/{workflow_id}/draft",
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([
'name' => '<string>',
'description' => '<string>',
'trigger_configuration' => '<unknown>',
'workflow_blocks' => [
'<unknown>'
],
'workflow_editor_state' => '<unknown>'
]),
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 := "http://localhost:8080/workflows/{workflow_id}/draft"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"trigger_configuration\": \"<unknown>\",\n \"workflow_blocks\": [\n \"<unknown>\"\n ],\n \"workflow_editor_state\": \"<unknown>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("http://localhost:8080/workflows/{workflow_id}/draft")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"trigger_configuration\": \"<unknown>\",\n \"workflow_blocks\": [\n \"<unknown>\"\n ],\n \"workflow_editor_state\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/workflows/{workflow_id}/draft")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"trigger_configuration\": \"<unknown>\",\n \"workflow_blocks\": [\n \"<unknown>\"\n ],\n \"workflow_editor_state\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"workflow_id": "<string>",
"name": "<string>",
"description": "<string>",
"is_active": true,
"trigger_type": "<string>",
"version_number": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"workflow_blocks": [
"<unknown>"
],
"trigger_configuration": "<unknown>",
"webhook_url": "<string>"
}{
"statusCode": 400,
"message": "<string>",
"error": "<string>",
"issues": [
{
"step_id": "<string>",
"message": "<string>",
"severity": "error"
}
]
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Workflows (Beta)
[Beta] Update a workflow draft in place when possible
[Beta] Update a workflow draft in place when possible — Updates the latest workflow version in place when it is a pristine draft (inactive and without recorded non-test runs).
PATCH
/
workflows
/
{workflow_id}
/
draft
[Beta] Update a workflow draft in place when possible
curl --request PATCH \
--url http://localhost:8080/workflows/{workflow_id}/draft \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"trigger_configuration": "<unknown>",
"workflow_blocks": [
"<unknown>"
],
"workflow_editor_state": "<unknown>"
}
'import requests
url = "http://localhost:8080/workflows/{workflow_id}/draft"
payload = {
"name": "<string>",
"description": "<string>",
"trigger_configuration": "<unknown>",
"workflow_blocks": ["<unknown>"],
"workflow_editor_state": "<unknown>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
trigger_configuration: '<unknown>',
workflow_blocks: ['<unknown>'],
workflow_editor_state: '<unknown>'
})
};
fetch('http://localhost:8080/workflows/{workflow_id}/draft', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/workflows/{workflow_id}/draft",
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([
'name' => '<string>',
'description' => '<string>',
'trigger_configuration' => '<unknown>',
'workflow_blocks' => [
'<unknown>'
],
'workflow_editor_state' => '<unknown>'
]),
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 := "http://localhost:8080/workflows/{workflow_id}/draft"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"trigger_configuration\": \"<unknown>\",\n \"workflow_blocks\": [\n \"<unknown>\"\n ],\n \"workflow_editor_state\": \"<unknown>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("http://localhost:8080/workflows/{workflow_id}/draft")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"trigger_configuration\": \"<unknown>\",\n \"workflow_blocks\": [\n \"<unknown>\"\n ],\n \"workflow_editor_state\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/workflows/{workflow_id}/draft")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"trigger_configuration\": \"<unknown>\",\n \"workflow_blocks\": [\n \"<unknown>\"\n ],\n \"workflow_editor_state\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"workflow_id": "<string>",
"name": "<string>",
"description": "<string>",
"is_active": true,
"trigger_type": "<string>",
"version_number": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"workflow_blocks": [
"<unknown>"
],
"trigger_configuration": "<unknown>",
"webhook_url": "<string>"
}{
"statusCode": 400,
"message": "<string>",
"error": "<string>",
"issues": [
{
"step_id": "<string>",
"message": "<string>",
"severity": "error"
}
]
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Authorizations
Body
application/json
New trigger type
Available options:
ivr-incoming-call, manual-trigger, ai-trigger, cron-trigger, form-trigger, webhook, contact-created, contact-updated, phone-call-started, phone-call-finished, ticket-created, sub-session-created, ticket-reassigned, ticket-resolved, ticket-handoff, pre-ticket-handoff, ticket-tag-added, ticket-inactive, agent-inactive, csat-score-submit, prohibited-topic-detected, sla-first-reply-breached, sla-next-reply-breached, sla-resolution-breached, voice-call-transferred, pre-voice-call-transfer, pre-phone-call-finished, manual-ticket-trigger, contact-message-received, first-contact-message-received, macro-called, macro-option-clicked, ai-response-completed, agent-availability-changed, agent-avail-in-team-changed, ai-response-requested, ticket-reopened, agent-mentioned, agent-message-posted, ticket-team-changed, session-updated, sequence-contact-replied, sequence-contact-completed, sequence-contact-parked, sequence-step-failed, sequence-contact-suppressed Response
Default Response
Was this page helpful?