curl --request POST \
--url https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/automation-rules/{automationRuleId}/propose-edits \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'cloudchat-instance: <cloudchat-instance>' \
--data '
{
"automation_rule": {
"name": "Tag billing conversations (v2)"
}
}
'import requests
url = "https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/automation-rules/{automationRuleId}/propose-edits"
payload = { "automation_rule": { "name": "Tag billing conversations (v2)" } }
headers = {
"cloudchat-instance": "<cloudchat-instance>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'cloudchat-instance': '<cloudchat-instance>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({automation_rule: {name: 'Tag billing conversations (v2)'}})
};
fetch('https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/automation-rules/{automationRuleId}/propose-edits', 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.cloudhumans.com/cloudchat/v1/accounts/{accountId}/automation-rules/{automationRuleId}/propose-edits",
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([
'automation_rule' => [
'name' => 'Tag billing conversations (v2)'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"cloudchat-instance: <cloudchat-instance>"
],
]);
$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.cloudhumans.com/cloudchat/v1/accounts/{accountId}/automation-rules/{automationRuleId}/propose-edits"
payload := strings.NewReader("{\n \"automation_rule\": {\n \"name\": \"Tag billing conversations (v2)\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cloudchat-instance", "<cloudchat-instance>")
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.cloudhumans.com/cloudchat/v1/accounts/{accountId}/automation-rules/{automationRuleId}/propose-edits")
.header("cloudchat-instance", "<cloudchat-instance>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"automation_rule\": {\n \"name\": \"Tag billing conversations (v2)\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/automation-rules/{automationRuleId}/propose-edits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cloudchat-instance"] = '<cloudchat-instance>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"automation_rule\": {\n \"name\": \"Tag billing conversations (v2)\"\n }\n}"
response = http.request(request)
puts response.read_body{
"proposal_token": "eyJfcmFpbHMiOnsiZGF0YSI6eyJqdGkiOiI0YjEw...",
"expires_at": "2026-11-12T14:20:00Z",
"kind": "edits",
"automation_rule_id": 31,
"diff": [
{
"field": "name",
"before": "Tag billing conversations",
"after": "Tag billing conversations (v2)"
}
],
"warnings": [
{
"code": "same_event_conflict",
"severity": "medium",
"message": "The active rule \"Route billing\" (#27) also changes team_id on this event and can match the same conversations. When both match, the one that runs last prevails: \"Tag billing conversations\".",
"rule_ids": [
27
]
}
]
}Propose automation rule edits
First half of changing a rule. Send only the fields to change; the response shows a diff (one before/after per changed field), the warnings of the rule as it would be, and a single-use proposal_token for confirmAutomationRuleEdits. Nothing is written. Administrator only — an agent token gets a 403.
Only a rule that is off can be edited. An active rule answers 409 rule_active: propose a new rule with the change instead, and let a person turn the new one on and the old one off in the automations screen. A rule managed by the ClaudIA integration answers 403. active in the payload is refused.
curl --request POST \
--url https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/automation-rules/{automationRuleId}/propose-edits \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'cloudchat-instance: <cloudchat-instance>' \
--data '
{
"automation_rule": {
"name": "Tag billing conversations (v2)"
}
}
'import requests
url = "https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/automation-rules/{automationRuleId}/propose-edits"
payload = { "automation_rule": { "name": "Tag billing conversations (v2)" } }
headers = {
"cloudchat-instance": "<cloudchat-instance>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'cloudchat-instance': '<cloudchat-instance>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({automation_rule: {name: 'Tag billing conversations (v2)'}})
};
fetch('https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/automation-rules/{automationRuleId}/propose-edits', 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.cloudhumans.com/cloudchat/v1/accounts/{accountId}/automation-rules/{automationRuleId}/propose-edits",
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([
'automation_rule' => [
'name' => 'Tag billing conversations (v2)'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"cloudchat-instance: <cloudchat-instance>"
],
]);
$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.cloudhumans.com/cloudchat/v1/accounts/{accountId}/automation-rules/{automationRuleId}/propose-edits"
payload := strings.NewReader("{\n \"automation_rule\": {\n \"name\": \"Tag billing conversations (v2)\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cloudchat-instance", "<cloudchat-instance>")
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.cloudhumans.com/cloudchat/v1/accounts/{accountId}/automation-rules/{automationRuleId}/propose-edits")
.header("cloudchat-instance", "<cloudchat-instance>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"automation_rule\": {\n \"name\": \"Tag billing conversations (v2)\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/automation-rules/{automationRuleId}/propose-edits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cloudchat-instance"] = '<cloudchat-instance>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"automation_rule\": {\n \"name\": \"Tag billing conversations (v2)\"\n }\n}"
response = http.request(request)
puts response.read_body{
"proposal_token": "eyJfcmFpbHMiOnsiZGF0YSI6eyJqdGkiOiI0YjEw...",
"expires_at": "2026-11-12T14:20:00Z",
"kind": "edits",
"automation_rule_id": 31,
"diff": [
{
"field": "name",
"before": "Tag billing conversations",
"after": "Tag billing conversations (v2)"
}
],
"warnings": [
{
"code": "same_event_conflict",
"severity": "medium",
"message": "The active rule \"Route billing\" (#27) also changes team_id on this event and can match the same conversations. When both match, the one that runs last prevails: \"Tag billing conversations\".",
"rule_ids": [
27
]
}
]
}rule_active. The event can’t change: sending a different event_name answers 422 event_change_not_allowed, so propose a new rule on the other event instead. See
Propose an automation rule
for the full walkthrough, the list of warnings, and who turns rules on.Authorizations
Headers
Your Cloud Chat instance ID — an integer, fixed for your company, told at onboarding. The API overview explains how instances work, how to find yours, and the errors a wrong or missing value produces.
1
Path Parameters
Your Cloud Chat account. It has to be an account your token grants membership on, and it has to live on the instance in the cloudchat-instance header — the two travel together. Account numbers are only unique within an instance, so the same number is a different company on another instance. Usually a mismatched pair fails closed with a 401, because your user does not exist on the other instance — but if your identity happens to exist on both, the call succeeds against the other company's data, silently. Read it and you are looking at the wrong help center; write it and you have stored into the wrong account. Send the two values that were given to you together, and never try a number to see what answers.
1
Body
Response
The proposal. Nothing was written.