Create or update a workflow
curl --request POST \
--url https://api.helloannie.com/v1/bots/{botId}/workflows \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"description": "<string>",
"steps": [
{
"title": "<string>",
"description": "<string>",
"instructions": "<string>",
"order": 0,
"examples": [
"<string>"
],
"action": "<string>",
"actionMetadata": {
"templateName": "Appointment Confirmation",
"templateBody": "Your appointment is scheduled for tomorrow at 3 PM."
},
"childSteps": [
{
"title": "<string>",
"description": "<string>",
"instructions": "<string>",
"order": 0,
"examples": [
"<string>"
],
"action": "<string>",
"actionMetadata": {
"templateName": "Appointment Confirmation",
"templateBody": "Your appointment is scheduled for tomorrow at 3 PM."
}
}
]
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enabled": true,
"usageContext": "<string>",
"order": 123
}
'import requests
url = "https://api.helloannie.com/v1/bots/{botId}/workflows"
payload = {
"title": "<string>",
"description": "<string>",
"steps": [
{
"title": "<string>",
"description": "<string>",
"instructions": "<string>",
"order": 0,
"examples": ["<string>"],
"action": "<string>",
"actionMetadata": {
"templateName": "Appointment Confirmation",
"templateBody": "Your appointment is scheduled for tomorrow at 3 PM."
},
"childSteps": [
{
"title": "<string>",
"description": "<string>",
"instructions": "<string>",
"order": 0,
"examples": ["<string>"],
"action": "<string>",
"actionMetadata": {
"templateName": "Appointment Confirmation",
"templateBody": "Your appointment is scheduled for tomorrow at 3 PM."
}
}
]
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enabled": True,
"usageContext": "<string>",
"order": 123
}
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({
title: '<string>',
description: '<string>',
steps: [
{
title: '<string>',
description: '<string>',
instructions: '<string>',
order: 0,
examples: ['<string>'],
action: '<string>',
actionMetadata: {
templateName: 'Appointment Confirmation',
templateBody: 'Your appointment is scheduled for tomorrow at 3 PM.'
},
childSteps: [
{
title: '<string>',
description: '<string>',
instructions: '<string>',
order: 0,
examples: ['<string>'],
action: '<string>',
actionMetadata: {
templateName: 'Appointment Confirmation',
templateBody: 'Your appointment is scheduled for tomorrow at 3 PM.'
}
}
]
}
],
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
enabled: true,
usageContext: '<string>',
order: 123
})
};
fetch('https://api.helloannie.com/v1/bots/{botId}/workflows', 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.helloannie.com/v1/bots/{botId}/workflows",
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([
'title' => '<string>',
'description' => '<string>',
'steps' => [
[
'title' => '<string>',
'description' => '<string>',
'instructions' => '<string>',
'order' => 0,
'examples' => [
'<string>'
],
'action' => '<string>',
'actionMetadata' => [
'templateName' => 'Appointment Confirmation',
'templateBody' => 'Your appointment is scheduled for tomorrow at 3 PM.'
],
'childSteps' => [
[
'title' => '<string>',
'description' => '<string>',
'instructions' => '<string>',
'order' => 0,
'examples' => [
'<string>'
],
'action' => '<string>',
'actionMetadata' => [
'templateName' => 'Appointment Confirmation',
'templateBody' => 'Your appointment is scheduled for tomorrow at 3 PM.'
]
]
]
]
],
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'enabled' => true,
'usageContext' => '<string>',
'order' => 123
]),
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.helloannie.com/v1/bots/{botId}/workflows"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"steps\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"order\": 0,\n \"examples\": [\n \"<string>\"\n ],\n \"action\": \"<string>\",\n \"actionMetadata\": {\n \"templateName\": \"Appointment Confirmation\",\n \"templateBody\": \"Your appointment is scheduled for tomorrow at 3 PM.\"\n },\n \"childSteps\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"order\": 0,\n \"examples\": [\n \"<string>\"\n ],\n \"action\": \"<string>\",\n \"actionMetadata\": {\n \"templateName\": \"Appointment Confirmation\",\n \"templateBody\": \"Your appointment is scheduled for tomorrow at 3 PM.\"\n }\n }\n ]\n }\n ],\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"enabled\": true,\n \"usageContext\": \"<string>\",\n \"order\": 123\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.helloannie.com/v1/bots/{botId}/workflows")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"steps\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"order\": 0,\n \"examples\": [\n \"<string>\"\n ],\n \"action\": \"<string>\",\n \"actionMetadata\": {\n \"templateName\": \"Appointment Confirmation\",\n \"templateBody\": \"Your appointment is scheduled for tomorrow at 3 PM.\"\n },\n \"childSteps\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"order\": 0,\n \"examples\": [\n \"<string>\"\n ],\n \"action\": \"<string>\",\n \"actionMetadata\": {\n \"templateName\": \"Appointment Confirmation\",\n \"templateBody\": \"Your appointment is scheduled for tomorrow at 3 PM.\"\n }\n }\n ]\n }\n ],\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"enabled\": true,\n \"usageContext\": \"<string>\",\n \"order\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helloannie.com/v1/bots/{botId}/workflows")
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 \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"steps\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"order\": 0,\n \"examples\": [\n \"<string>\"\n ],\n \"action\": \"<string>\",\n \"actionMetadata\": {\n \"templateName\": \"Appointment Confirmation\",\n \"templateBody\": \"Your appointment is scheduled for tomorrow at 3 PM.\"\n },\n \"childSteps\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"order\": 0,\n \"examples\": [\n \"<string>\"\n ],\n \"action\": \"<string>\",\n \"actionMetadata\": {\n \"templateName\": \"Appointment Confirmation\",\n \"templateBody\": \"Your appointment is scheduled for tomorrow at 3 PM.\"\n }\n }\n ]\n }\n ],\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"enabled\": true,\n \"usageContext\": \"<string>\",\n \"order\": 123\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"description": "<string>",
"enabled": true,
"usageContext": "<string>",
"steps": [
{
"title": "<string>",
"description": "<string>",
"instructions": "<string>",
"examples": [
"<string>"
],
"order": 0,
"childSteps": [
{
"title": "<string>",
"description": "<string>",
"instructions": "<string>",
"examples": [
"<string>"
],
"order": 0,
"action": "<string>",
"actionMetadata": {
"templateName": "Appointment Confirmation",
"templateBody": "Your appointment is scheduled for tomorrow at 3 PM."
}
}
],
"action": "<string>",
"actionMetadata": {
"templateName": "Appointment Confirmation",
"templateBody": "Your appointment is scheduled for tomorrow at 3 PM."
}
}
]
}
}{
"success": false,
"data": {},
"message": "<string>"
}{
"success": false,
"data": {},
"message": "<string>"
}{
"success": false,
"data": {},
"message": "<string>"
}{
"success": false,
"data": {},
"message": "<string>"
}Workflows
Create or update a workflow
Create a new workflow or update an existing one. If an id is provided in the request body, the workflow will be updated; otherwise, a new workflow will be created. When creating, enabled defaults to true and order defaults to 0 if omitted. When updating, omitting enabled or order leaves the stored value unchanged. A TRANSFER_CALL destination is identified by its actionMetadata.name (ignoring case, accents and trailing spaces) across all of the bot’s workflows: one request can’t give a name two different numbers or extensions, and saving a new number under an existing name changes it for every workflow on the bot that uses that name. When an update stops using a destination and no other step on the bot uses it, the destination is removed from the bot, unless the bot has call transfer turned on for every conversation: those bots keep all their destinations.
POST
/
bots
/
{botId}
/
workflows
Create or update a workflow
curl --request POST \
--url https://api.helloannie.com/v1/bots/{botId}/workflows \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"description": "<string>",
"steps": [
{
"title": "<string>",
"description": "<string>",
"instructions": "<string>",
"order": 0,
"examples": [
"<string>"
],
"action": "<string>",
"actionMetadata": {
"templateName": "Appointment Confirmation",
"templateBody": "Your appointment is scheduled for tomorrow at 3 PM."
},
"childSteps": [
{
"title": "<string>",
"description": "<string>",
"instructions": "<string>",
"order": 0,
"examples": [
"<string>"
],
"action": "<string>",
"actionMetadata": {
"templateName": "Appointment Confirmation",
"templateBody": "Your appointment is scheduled for tomorrow at 3 PM."
}
}
]
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enabled": true,
"usageContext": "<string>",
"order": 123
}
'import requests
url = "https://api.helloannie.com/v1/bots/{botId}/workflows"
payload = {
"title": "<string>",
"description": "<string>",
"steps": [
{
"title": "<string>",
"description": "<string>",
"instructions": "<string>",
"order": 0,
"examples": ["<string>"],
"action": "<string>",
"actionMetadata": {
"templateName": "Appointment Confirmation",
"templateBody": "Your appointment is scheduled for tomorrow at 3 PM."
},
"childSteps": [
{
"title": "<string>",
"description": "<string>",
"instructions": "<string>",
"order": 0,
"examples": ["<string>"],
"action": "<string>",
"actionMetadata": {
"templateName": "Appointment Confirmation",
"templateBody": "Your appointment is scheduled for tomorrow at 3 PM."
}
}
]
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enabled": True,
"usageContext": "<string>",
"order": 123
}
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({
title: '<string>',
description: '<string>',
steps: [
{
title: '<string>',
description: '<string>',
instructions: '<string>',
order: 0,
examples: ['<string>'],
action: '<string>',
actionMetadata: {
templateName: 'Appointment Confirmation',
templateBody: 'Your appointment is scheduled for tomorrow at 3 PM.'
},
childSteps: [
{
title: '<string>',
description: '<string>',
instructions: '<string>',
order: 0,
examples: ['<string>'],
action: '<string>',
actionMetadata: {
templateName: 'Appointment Confirmation',
templateBody: 'Your appointment is scheduled for tomorrow at 3 PM.'
}
}
]
}
],
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
enabled: true,
usageContext: '<string>',
order: 123
})
};
fetch('https://api.helloannie.com/v1/bots/{botId}/workflows', 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.helloannie.com/v1/bots/{botId}/workflows",
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([
'title' => '<string>',
'description' => '<string>',
'steps' => [
[
'title' => '<string>',
'description' => '<string>',
'instructions' => '<string>',
'order' => 0,
'examples' => [
'<string>'
],
'action' => '<string>',
'actionMetadata' => [
'templateName' => 'Appointment Confirmation',
'templateBody' => 'Your appointment is scheduled for tomorrow at 3 PM.'
],
'childSteps' => [
[
'title' => '<string>',
'description' => '<string>',
'instructions' => '<string>',
'order' => 0,
'examples' => [
'<string>'
],
'action' => '<string>',
'actionMetadata' => [
'templateName' => 'Appointment Confirmation',
'templateBody' => 'Your appointment is scheduled for tomorrow at 3 PM.'
]
]
]
]
],
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'enabled' => true,
'usageContext' => '<string>',
'order' => 123
]),
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.helloannie.com/v1/bots/{botId}/workflows"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"steps\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"order\": 0,\n \"examples\": [\n \"<string>\"\n ],\n \"action\": \"<string>\",\n \"actionMetadata\": {\n \"templateName\": \"Appointment Confirmation\",\n \"templateBody\": \"Your appointment is scheduled for tomorrow at 3 PM.\"\n },\n \"childSteps\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"order\": 0,\n \"examples\": [\n \"<string>\"\n ],\n \"action\": \"<string>\",\n \"actionMetadata\": {\n \"templateName\": \"Appointment Confirmation\",\n \"templateBody\": \"Your appointment is scheduled for tomorrow at 3 PM.\"\n }\n }\n ]\n }\n ],\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"enabled\": true,\n \"usageContext\": \"<string>\",\n \"order\": 123\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.helloannie.com/v1/bots/{botId}/workflows")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"steps\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"order\": 0,\n \"examples\": [\n \"<string>\"\n ],\n \"action\": \"<string>\",\n \"actionMetadata\": {\n \"templateName\": \"Appointment Confirmation\",\n \"templateBody\": \"Your appointment is scheduled for tomorrow at 3 PM.\"\n },\n \"childSteps\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"order\": 0,\n \"examples\": [\n \"<string>\"\n ],\n \"action\": \"<string>\",\n \"actionMetadata\": {\n \"templateName\": \"Appointment Confirmation\",\n \"templateBody\": \"Your appointment is scheduled for tomorrow at 3 PM.\"\n }\n }\n ]\n }\n ],\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"enabled\": true,\n \"usageContext\": \"<string>\",\n \"order\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helloannie.com/v1/bots/{botId}/workflows")
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 \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"steps\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"order\": 0,\n \"examples\": [\n \"<string>\"\n ],\n \"action\": \"<string>\",\n \"actionMetadata\": {\n \"templateName\": \"Appointment Confirmation\",\n \"templateBody\": \"Your appointment is scheduled for tomorrow at 3 PM.\"\n },\n \"childSteps\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"order\": 0,\n \"examples\": [\n \"<string>\"\n ],\n \"action\": \"<string>\",\n \"actionMetadata\": {\n \"templateName\": \"Appointment Confirmation\",\n \"templateBody\": \"Your appointment is scheduled for tomorrow at 3 PM.\"\n }\n }\n ]\n }\n ],\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"enabled\": true,\n \"usageContext\": \"<string>\",\n \"order\": 123\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"description": "<string>",
"enabled": true,
"usageContext": "<string>",
"steps": [
{
"title": "<string>",
"description": "<string>",
"instructions": "<string>",
"examples": [
"<string>"
],
"order": 0,
"childSteps": [
{
"title": "<string>",
"description": "<string>",
"instructions": "<string>",
"examples": [
"<string>"
],
"order": 0,
"action": "<string>",
"actionMetadata": {
"templateName": "Appointment Confirmation",
"templateBody": "Your appointment is scheduled for tomorrow at 3 PM."
}
}
],
"action": "<string>",
"actionMetadata": {
"templateName": "Appointment Confirmation",
"templateBody": "Your appointment is scheduled for tomorrow at 3 PM."
}
}
]
}
}{
"success": false,
"data": {},
"message": "<string>"
}{
"success": false,
"data": {},
"message": "<string>"
}{
"success": false,
"data": {},
"message": "<string>"
}{
"success": false,
"data": {},
"message": "<string>"
}Authorizations
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Request body for creating or updating a workflow