Update agent workflow
curl --request PATCH \
--url https://prod.featherhq.com/api/v1/workflow/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"active": true,
"startHour": 9,
"endHour": 17,
"timezone": "America/Los_Angeles",
"workflowSchedule": {
"monday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"tuesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"wednesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"thursday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"friday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"saturday": {
"enabled": false,
"timeRanges": []
},
"sunday": {
"enabled": false,
"timeRanges": []
}
},
"tcpaSchedule": {
"monday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"tuesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"wednesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"thursday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"friday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"saturday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"sunday": {
"enabled": true,
"timeRanges": [
{
"startHour": 13,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
}
},
"maxDialsPerTick": 2
}
'import requests
url = "https://prod.featherhq.com/api/v1/workflow/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"active": True,
"startHour": 9,
"endHour": 17,
"timezone": "America/Los_Angeles",
"workflowSchedule": {
"monday": {
"enabled": True,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"tuesday": {
"enabled": True,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"wednesday": {
"enabled": True,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"thursday": {
"enabled": True,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"friday": {
"enabled": True,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"saturday": {
"enabled": False,
"timeRanges": []
},
"sunday": {
"enabled": False,
"timeRanges": []
}
},
"tcpaSchedule": {
"monday": {
"enabled": True,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"tuesday": {
"enabled": True,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"wednesday": {
"enabled": True,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"thursday": {
"enabled": True,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"friday": {
"enabled": True,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"saturday": {
"enabled": True,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"sunday": {
"enabled": True,
"timeRanges": [
{
"startHour": 13,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
}
},
"maxDialsPerTick": 2
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
active: true,
startHour: 9,
endHour: 17,
timezone: 'America/Los_Angeles',
workflowSchedule: {
monday: {
enabled: true,
timeRanges: [{startHour: 9, startMinute: 0, endHour: 17, endMinute: 0}]
},
tuesday: {
enabled: true,
timeRanges: [{startHour: 9, startMinute: 0, endHour: 17, endMinute: 0}]
},
wednesday: {
enabled: true,
timeRanges: [{startHour: 9, startMinute: 0, endHour: 17, endMinute: 0}]
},
thursday: {
enabled: true,
timeRanges: [{startHour: 9, startMinute: 0, endHour: 17, endMinute: 0}]
},
friday: {
enabled: true,
timeRanges: [{startHour: 9, startMinute: 0, endHour: 17, endMinute: 0}]
},
saturday: {enabled: false, timeRanges: []},
sunday: {enabled: false, timeRanges: []}
},
tcpaSchedule: {
monday: {
enabled: true,
timeRanges: [{startHour: 8, startMinute: 0, endHour: 21, endMinute: 0}]
},
tuesday: {
enabled: true,
timeRanges: [{startHour: 8, startMinute: 0, endHour: 21, endMinute: 0}]
},
wednesday: {
enabled: true,
timeRanges: [{startHour: 8, startMinute: 0, endHour: 21, endMinute: 0}]
},
thursday: {
enabled: true,
timeRanges: [{startHour: 8, startMinute: 0, endHour: 21, endMinute: 0}]
},
friday: {
enabled: true,
timeRanges: [{startHour: 8, startMinute: 0, endHour: 21, endMinute: 0}]
},
saturday: {
enabled: true,
timeRanges: [{startHour: 8, startMinute: 0, endHour: 21, endMinute: 0}]
},
sunday: {
enabled: true,
timeRanges: [{startHour: 13, startMinute: 0, endHour: 21, endMinute: 0}]
}
},
maxDialsPerTick: 2
})
};
fetch('https://prod.featherhq.com/api/v1/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://prod.featherhq.com/api/v1/workflow/{id}",
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>',
'active' => true,
'startHour' => 9,
'endHour' => 17,
'timezone' => 'America/Los_Angeles',
'workflowSchedule' => [
'monday' => [
'enabled' => true,
'timeRanges' => [
[
'startHour' => 9,
'startMinute' => 0,
'endHour' => 17,
'endMinute' => 0
]
]
],
'tuesday' => [
'enabled' => true,
'timeRanges' => [
[
'startHour' => 9,
'startMinute' => 0,
'endHour' => 17,
'endMinute' => 0
]
]
],
'wednesday' => [
'enabled' => true,
'timeRanges' => [
[
'startHour' => 9,
'startMinute' => 0,
'endHour' => 17,
'endMinute' => 0
]
]
],
'thursday' => [
'enabled' => true,
'timeRanges' => [
[
'startHour' => 9,
'startMinute' => 0,
'endHour' => 17,
'endMinute' => 0
]
]
],
'friday' => [
'enabled' => true,
'timeRanges' => [
[
'startHour' => 9,
'startMinute' => 0,
'endHour' => 17,
'endMinute' => 0
]
]
],
'saturday' => [
'enabled' => false,
'timeRanges' => [
]
],
'sunday' => [
'enabled' => false,
'timeRanges' => [
]
]
],
'tcpaSchedule' => [
'monday' => [
'enabled' => true,
'timeRanges' => [
[
'startHour' => 8,
'startMinute' => 0,
'endHour' => 21,
'endMinute' => 0
]
]
],
'tuesday' => [
'enabled' => true,
'timeRanges' => [
[
'startHour' => 8,
'startMinute' => 0,
'endHour' => 21,
'endMinute' => 0
]
]
],
'wednesday' => [
'enabled' => true,
'timeRanges' => [
[
'startHour' => 8,
'startMinute' => 0,
'endHour' => 21,
'endMinute' => 0
]
]
],
'thursday' => [
'enabled' => true,
'timeRanges' => [
[
'startHour' => 8,
'startMinute' => 0,
'endHour' => 21,
'endMinute' => 0
]
]
],
'friday' => [
'enabled' => true,
'timeRanges' => [
[
'startHour' => 8,
'startMinute' => 0,
'endHour' => 21,
'endMinute' => 0
]
]
],
'saturday' => [
'enabled' => true,
'timeRanges' => [
[
'startHour' => 8,
'startMinute' => 0,
'endHour' => 21,
'endMinute' => 0
]
]
],
'sunday' => [
'enabled' => true,
'timeRanges' => [
[
'startHour' => 13,
'startMinute' => 0,
'endHour' => 21,
'endMinute' => 0
]
]
]
],
'maxDialsPerTick' => 2
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <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://prod.featherhq.com/api/v1/workflow/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"active\": true,\n \"startHour\": 9,\n \"endHour\": 17,\n \"timezone\": \"America/Los_Angeles\",\n \"workflowSchedule\": {\n \"monday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"tuesday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"wednesday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"thursday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"friday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"saturday\": {\n \"enabled\": false,\n \"timeRanges\": []\n },\n \"sunday\": {\n \"enabled\": false,\n \"timeRanges\": []\n }\n },\n \"tcpaSchedule\": {\n \"monday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"tuesday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"wednesday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"thursday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"friday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"saturday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"sunday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 13,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n }\n },\n \"maxDialsPerTick\": 2\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<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.patch("https://prod.featherhq.com/api/v1/workflow/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"active\": true,\n \"startHour\": 9,\n \"endHour\": 17,\n \"timezone\": \"America/Los_Angeles\",\n \"workflowSchedule\": {\n \"monday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"tuesday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"wednesday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"thursday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"friday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"saturday\": {\n \"enabled\": false,\n \"timeRanges\": []\n },\n \"sunday\": {\n \"enabled\": false,\n \"timeRanges\": []\n }\n },\n \"tcpaSchedule\": {\n \"monday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"tuesday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"wednesday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"thursday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"friday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"saturday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"sunday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 13,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n }\n },\n \"maxDialsPerTick\": 2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod.featherhq.com/api/v1/workflow/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"active\": true,\n \"startHour\": 9,\n \"endHour\": 17,\n \"timezone\": \"America/Los_Angeles\",\n \"workflowSchedule\": {\n \"monday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"tuesday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"wednesday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"thursday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"friday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"saturday\": {\n \"enabled\": false,\n \"timeRanges\": []\n },\n \"sunday\": {\n \"enabled\": false,\n \"timeRanges\": []\n }\n },\n \"tcpaSchedule\": {\n \"monday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"tuesday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"wednesday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"thursday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"friday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"saturday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"sunday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 13,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n }\n },\n \"maxDialsPerTick\": 2\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"active": true,
"startHour": 123,
"endHour": 123,
"timezone": "<string>",
"workflowSchedule": {
"monday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"tuesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"wednesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"thursday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"friday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"saturday": {
"enabled": false,
"timeRanges": []
},
"sunday": {
"enabled": false,
"timeRanges": []
}
},
"tcpaSchedule": {
"monday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"tuesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"wednesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"thursday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"friday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"saturday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"sunday": {
"enabled": true,
"timeRanges": [
{
"startHour": 13,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
}
},
"definition": {
"steps": [
{
"order": 2,
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"delayInSecs": 0,
"finishOn": [],
"leaveVoicemail": false,
"initialMessage": "<string>",
"count": 1
}
],
"isInfinite": false
},
"maxDialsPerTick": 2,
"createdAt": "<string>",
"updatedAt": "<string>"
}{
"status": 400,
"message": "Bad request",
"code": "BAD_REQUEST",
"success": false
}{
"status": 500,
"message": "Internal server error",
"code": "INTERNAL_SERVER_ERROR",
"success": false
}Workflows
Update agent workflow
Update an agent workflow
PATCH
/
api
/
v1
/
workflow
/
{id}
Update agent workflow
curl --request PATCH \
--url https://prod.featherhq.com/api/v1/workflow/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"active": true,
"startHour": 9,
"endHour": 17,
"timezone": "America/Los_Angeles",
"workflowSchedule": {
"monday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"tuesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"wednesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"thursday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"friday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"saturday": {
"enabled": false,
"timeRanges": []
},
"sunday": {
"enabled": false,
"timeRanges": []
}
},
"tcpaSchedule": {
"monday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"tuesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"wednesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"thursday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"friday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"saturday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"sunday": {
"enabled": true,
"timeRanges": [
{
"startHour": 13,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
}
},
"maxDialsPerTick": 2
}
'import requests
url = "https://prod.featherhq.com/api/v1/workflow/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"active": True,
"startHour": 9,
"endHour": 17,
"timezone": "America/Los_Angeles",
"workflowSchedule": {
"monday": {
"enabled": True,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"tuesday": {
"enabled": True,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"wednesday": {
"enabled": True,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"thursday": {
"enabled": True,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"friday": {
"enabled": True,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"saturday": {
"enabled": False,
"timeRanges": []
},
"sunday": {
"enabled": False,
"timeRanges": []
}
},
"tcpaSchedule": {
"monday": {
"enabled": True,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"tuesday": {
"enabled": True,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"wednesday": {
"enabled": True,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"thursday": {
"enabled": True,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"friday": {
"enabled": True,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"saturday": {
"enabled": True,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"sunday": {
"enabled": True,
"timeRanges": [
{
"startHour": 13,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
}
},
"maxDialsPerTick": 2
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
active: true,
startHour: 9,
endHour: 17,
timezone: 'America/Los_Angeles',
workflowSchedule: {
monday: {
enabled: true,
timeRanges: [{startHour: 9, startMinute: 0, endHour: 17, endMinute: 0}]
},
tuesday: {
enabled: true,
timeRanges: [{startHour: 9, startMinute: 0, endHour: 17, endMinute: 0}]
},
wednesday: {
enabled: true,
timeRanges: [{startHour: 9, startMinute: 0, endHour: 17, endMinute: 0}]
},
thursday: {
enabled: true,
timeRanges: [{startHour: 9, startMinute: 0, endHour: 17, endMinute: 0}]
},
friday: {
enabled: true,
timeRanges: [{startHour: 9, startMinute: 0, endHour: 17, endMinute: 0}]
},
saturday: {enabled: false, timeRanges: []},
sunday: {enabled: false, timeRanges: []}
},
tcpaSchedule: {
monday: {
enabled: true,
timeRanges: [{startHour: 8, startMinute: 0, endHour: 21, endMinute: 0}]
},
tuesday: {
enabled: true,
timeRanges: [{startHour: 8, startMinute: 0, endHour: 21, endMinute: 0}]
},
wednesday: {
enabled: true,
timeRanges: [{startHour: 8, startMinute: 0, endHour: 21, endMinute: 0}]
},
thursday: {
enabled: true,
timeRanges: [{startHour: 8, startMinute: 0, endHour: 21, endMinute: 0}]
},
friday: {
enabled: true,
timeRanges: [{startHour: 8, startMinute: 0, endHour: 21, endMinute: 0}]
},
saturday: {
enabled: true,
timeRanges: [{startHour: 8, startMinute: 0, endHour: 21, endMinute: 0}]
},
sunday: {
enabled: true,
timeRanges: [{startHour: 13, startMinute: 0, endHour: 21, endMinute: 0}]
}
},
maxDialsPerTick: 2
})
};
fetch('https://prod.featherhq.com/api/v1/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://prod.featherhq.com/api/v1/workflow/{id}",
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>',
'active' => true,
'startHour' => 9,
'endHour' => 17,
'timezone' => 'America/Los_Angeles',
'workflowSchedule' => [
'monday' => [
'enabled' => true,
'timeRanges' => [
[
'startHour' => 9,
'startMinute' => 0,
'endHour' => 17,
'endMinute' => 0
]
]
],
'tuesday' => [
'enabled' => true,
'timeRanges' => [
[
'startHour' => 9,
'startMinute' => 0,
'endHour' => 17,
'endMinute' => 0
]
]
],
'wednesday' => [
'enabled' => true,
'timeRanges' => [
[
'startHour' => 9,
'startMinute' => 0,
'endHour' => 17,
'endMinute' => 0
]
]
],
'thursday' => [
'enabled' => true,
'timeRanges' => [
[
'startHour' => 9,
'startMinute' => 0,
'endHour' => 17,
'endMinute' => 0
]
]
],
'friday' => [
'enabled' => true,
'timeRanges' => [
[
'startHour' => 9,
'startMinute' => 0,
'endHour' => 17,
'endMinute' => 0
]
]
],
'saturday' => [
'enabled' => false,
'timeRanges' => [
]
],
'sunday' => [
'enabled' => false,
'timeRanges' => [
]
]
],
'tcpaSchedule' => [
'monday' => [
'enabled' => true,
'timeRanges' => [
[
'startHour' => 8,
'startMinute' => 0,
'endHour' => 21,
'endMinute' => 0
]
]
],
'tuesday' => [
'enabled' => true,
'timeRanges' => [
[
'startHour' => 8,
'startMinute' => 0,
'endHour' => 21,
'endMinute' => 0
]
]
],
'wednesday' => [
'enabled' => true,
'timeRanges' => [
[
'startHour' => 8,
'startMinute' => 0,
'endHour' => 21,
'endMinute' => 0
]
]
],
'thursday' => [
'enabled' => true,
'timeRanges' => [
[
'startHour' => 8,
'startMinute' => 0,
'endHour' => 21,
'endMinute' => 0
]
]
],
'friday' => [
'enabled' => true,
'timeRanges' => [
[
'startHour' => 8,
'startMinute' => 0,
'endHour' => 21,
'endMinute' => 0
]
]
],
'saturday' => [
'enabled' => true,
'timeRanges' => [
[
'startHour' => 8,
'startMinute' => 0,
'endHour' => 21,
'endMinute' => 0
]
]
],
'sunday' => [
'enabled' => true,
'timeRanges' => [
[
'startHour' => 13,
'startMinute' => 0,
'endHour' => 21,
'endMinute' => 0
]
]
]
],
'maxDialsPerTick' => 2
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <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://prod.featherhq.com/api/v1/workflow/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"active\": true,\n \"startHour\": 9,\n \"endHour\": 17,\n \"timezone\": \"America/Los_Angeles\",\n \"workflowSchedule\": {\n \"monday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"tuesday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"wednesday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"thursday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"friday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"saturday\": {\n \"enabled\": false,\n \"timeRanges\": []\n },\n \"sunday\": {\n \"enabled\": false,\n \"timeRanges\": []\n }\n },\n \"tcpaSchedule\": {\n \"monday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"tuesday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"wednesday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"thursday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"friday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"saturday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"sunday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 13,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n }\n },\n \"maxDialsPerTick\": 2\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<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.patch("https://prod.featherhq.com/api/v1/workflow/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"active\": true,\n \"startHour\": 9,\n \"endHour\": 17,\n \"timezone\": \"America/Los_Angeles\",\n \"workflowSchedule\": {\n \"monday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"tuesday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"wednesday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"thursday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"friday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"saturday\": {\n \"enabled\": false,\n \"timeRanges\": []\n },\n \"sunday\": {\n \"enabled\": false,\n \"timeRanges\": []\n }\n },\n \"tcpaSchedule\": {\n \"monday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"tuesday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"wednesday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"thursday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"friday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"saturday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"sunday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 13,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n }\n },\n \"maxDialsPerTick\": 2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod.featherhq.com/api/v1/workflow/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"active\": true,\n \"startHour\": 9,\n \"endHour\": 17,\n \"timezone\": \"America/Los_Angeles\",\n \"workflowSchedule\": {\n \"monday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"tuesday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"wednesday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"thursday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"friday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 9,\n \"startMinute\": 0,\n \"endHour\": 17,\n \"endMinute\": 0\n }\n ]\n },\n \"saturday\": {\n \"enabled\": false,\n \"timeRanges\": []\n },\n \"sunday\": {\n \"enabled\": false,\n \"timeRanges\": []\n }\n },\n \"tcpaSchedule\": {\n \"monday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"tuesday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"wednesday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"thursday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"friday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"saturday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 8,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n },\n \"sunday\": {\n \"enabled\": true,\n \"timeRanges\": [\n {\n \"startHour\": 13,\n \"startMinute\": 0,\n \"endHour\": 21,\n \"endMinute\": 0\n }\n ]\n }\n },\n \"maxDialsPerTick\": 2\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"active": true,
"startHour": 123,
"endHour": 123,
"timezone": "<string>",
"workflowSchedule": {
"monday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"tuesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"wednesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"thursday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"friday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"saturday": {
"enabled": false,
"timeRanges": []
},
"sunday": {
"enabled": false,
"timeRanges": []
}
},
"tcpaSchedule": {
"monday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"tuesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"wednesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"thursday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"friday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"saturday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"sunday": {
"enabled": true,
"timeRanges": [
{
"startHour": 13,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
}
},
"definition": {
"steps": [
{
"order": 2,
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"delayInSecs": 0,
"finishOn": [],
"leaveVoicemail": false,
"initialMessage": "<string>",
"count": 1
}
],
"isInfinite": false
},
"maxDialsPerTick": 2,
"createdAt": "<string>",
"updatedAt": "<string>"
}{
"status": 400,
"message": "Bad request",
"code": "BAD_REQUEST",
"success": false
}{
"status": 500,
"message": "Internal server error",
"code": "INTERNAL_SERVER_ERROR",
"success": false
}Authorizations
Path Parameters
Body
application/json
Workflow name
Required string length:
1 - 255Workflow description
Whether the workflow is active
Start hour (0-23) for backward compatibility
Required range:
0 <= x <= 23End hour (0-23) for backward compatibility
Required range:
0 <= x <= 23Timezone for workflow execution and schedule interpretation
Workflow schedule - operates in workflow timezone defined above
Show child attributes
Show child attributes
Example:
{
"monday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"tuesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"wednesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"thursday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"friday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"saturday": { "enabled": false, "timeRanges": [] },
"sunday": { "enabled": false, "timeRanges": [] }
}
TCPA schedule - applies to borrower local timezone
Show child attributes
Show child attributes
Example:
{
"monday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"tuesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"wednesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"thursday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"friday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"saturday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"sunday": {
"enabled": true,
"timeRanges": [
{
"startHour": 13,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
}
}
Workflow definition
Show child attributes
Show child attributes
Per-workflow max dials per scheduler tick. null = uncapped (uses shared org budget).
Required range:
x >= 1Response
Agent workflow updated successfully
Workflow ID
Workflow name
Workflow description
Organization ID
User ID who created the workflow
Whether the workflow is active
Start hour (0-23) for backward compatibility
End hour (0-23) for backward compatibility
Timezone for workflow execution and schedule interpretation
Workflow schedule - operates in workflow timezone
Show child attributes
Show child attributes
Example:
{
"monday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"tuesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"wednesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"thursday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"friday": {
"enabled": true,
"timeRanges": [
{
"startHour": 9,
"startMinute": 0,
"endHour": 17,
"endMinute": 0
}
]
},
"saturday": { "enabled": false, "timeRanges": [] },
"sunday": { "enabled": false, "timeRanges": [] }
}
TCPA schedule - applies to borrower local timezone
Show child attributes
Show child attributes
Example:
{
"monday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"tuesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"wednesday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"thursday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"friday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"saturday": {
"enabled": true,
"timeRanges": [
{
"startHour": 8,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
},
"sunday": {
"enabled": true,
"timeRanges": [
{
"startHour": 13,
"startMinute": 0,
"endHour": 21,
"endMinute": 0
}
]
}
}
Workflow definition
Show child attributes
Show child attributes
Per-workflow max dials per scheduler tick. null = uncapped (uses shared org budget).
Required range:
x >= 1Creation timestamp
Last update timestamp
⌘I