Update conversational-automation config
curl --request PUT \
--url https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"enable_welcome_message": true,
"prompts": [
"<string>"
],
"commands": [
{
"command_name": "<string>",
"command_description": "<string>"
}
]
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation"
payload = {
"enable_welcome_message": True,
"prompts": ["<string>"],
"commands": [
{
"command_name": "<string>",
"command_description": "<string>"
}
]
}
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({
enable_welcome_message: true,
prompts: ['<string>'],
commands: [{command_name: '<string>', command_description: '<string>'}]
})
};
fetch('https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation', 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.orbit.devotel.io/api/v1/whatsapp/conversational-automation",
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([
'enable_welcome_message' => true,
'prompts' => [
'<string>'
],
'commands' => [
[
'command_name' => '<string>',
'command_description' => '<string>'
]
]
]),
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.orbit.devotel.io/api/v1/whatsapp/conversational-automation"
payload := strings.NewReader("{\n \"enable_welcome_message\": true,\n \"prompts\": [\n \"<string>\"\n ],\n \"commands\": [\n {\n \"command_name\": \"<string>\",\n \"command_description\": \"<string>\"\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.orbit.devotel.io/api/v1/whatsapp/conversational-automation")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"enable_welcome_message\": true,\n \"prompts\": [\n \"<string>\"\n ],\n \"commands\": [\n {\n \"command_name\": \"<string>\",\n \"command_description\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation")
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 \"enable_welcome_message\": true,\n \"prompts\": [\n \"<string>\"\n ],\n \"commands\": [\n {\n \"command_name\": \"<string>\",\n \"command_description\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"ok": true
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}WhatsApp
Update conversational-automation config
Replace the WhatsApp conversational-automation configuration for the organization’s default connection. WhatsApp replaces each field present on the write, so send the complete desired state — the welcome-message flag plus all ice breakers and commands — to avoid clearing a sibling field. Restricted to owners and admins.
PUT
/
api
/
v1
/
whatsapp
/
conversational-automation
Update conversational-automation config
curl --request PUT \
--url https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"enable_welcome_message": true,
"prompts": [
"<string>"
],
"commands": [
{
"command_name": "<string>",
"command_description": "<string>"
}
]
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation"
payload = {
"enable_welcome_message": True,
"prompts": ["<string>"],
"commands": [
{
"command_name": "<string>",
"command_description": "<string>"
}
]
}
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({
enable_welcome_message: true,
prompts: ['<string>'],
commands: [{command_name: '<string>', command_description: '<string>'}]
})
};
fetch('https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation', 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.orbit.devotel.io/api/v1/whatsapp/conversational-automation",
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([
'enable_welcome_message' => true,
'prompts' => [
'<string>'
],
'commands' => [
[
'command_name' => '<string>',
'command_description' => '<string>'
]
]
]),
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.orbit.devotel.io/api/v1/whatsapp/conversational-automation"
payload := strings.NewReader("{\n \"enable_welcome_message\": true,\n \"prompts\": [\n \"<string>\"\n ],\n \"commands\": [\n {\n \"command_name\": \"<string>\",\n \"command_description\": \"<string>\"\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.orbit.devotel.io/api/v1/whatsapp/conversational-automation")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"enable_welcome_message\": true,\n \"prompts\": [\n \"<string>\"\n ],\n \"commands\": [\n {\n \"command_name\": \"<string>\",\n \"command_description\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation")
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 \"enable_welcome_message\": true,\n \"prompts\": [\n \"<string>\"\n ],\n \"commands\": [\n {\n \"command_name\": \"<string>\",\n \"command_description\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"ok": true
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Body
application/json
Toggle WhatsApp's automatic welcome message on first open.
Ice breakers — up to four tappable prompts shown when a customer first opens the chat.
Maximum array length:
4Required string length:
1 - 80Slash commands surfaced in the chat command menu (up to 30).
Maximum array length:
30Show child attributes
Show child attributes
⌘I