curl --request POST \
--url https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/macros \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'cloudchat-instance: <cloudchat-instance>' \
--data '
{
"macro": {
"name": "Refund flow",
"actions": [
{
"action_name": "add_label",
"action_params": [
"refund"
]
}
],
"visibility": "global"
}
}
'import requests
url = "https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/macros"
payload = { "macro": {
"name": "Refund flow",
"actions": [
{
"action_name": "add_label",
"action_params": ["refund"]
}
],
"visibility": "global"
} }
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({
macro: {
name: 'Refund flow',
actions: [{action_name: 'add_label', action_params: ['refund']}],
visibility: 'global'
}
})
};
fetch('https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/macros', 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}/macros",
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([
'macro' => [
'name' => 'Refund flow',
'actions' => [
[
'action_name' => 'add_label',
'action_params' => [
'refund'
]
]
],
'visibility' => 'global'
]
]),
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}/macros"
payload := strings.NewReader("{\n \"macro\": {\n \"name\": \"Refund flow\",\n \"actions\": [\n {\n \"action_name\": \"add_label\",\n \"action_params\": [\n \"refund\"\n ]\n }\n ],\n \"visibility\": \"global\"\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}/macros")
.header("cloudchat-instance", "<cloudchat-instance>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"macro\": {\n \"name\": \"Refund flow\",\n \"actions\": [\n {\n \"action_name\": \"add_label\",\n \"action_params\": [\n \"refund\"\n ]\n }\n ],\n \"visibility\": \"global\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/macros")
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 \"macro\": {\n \"name\": \"Refund flow\",\n \"actions\": [\n {\n \"action_name\": \"add_label\",\n \"action_params\": [\n \"refund\"\n ]\n }\n ],\n \"visibility\": \"global\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 21,
"name": "Refund flow",
"visibility": "global",
"actions": [
{
"action_name": "add_label",
"action_params": [
"refund"
]
}
],
"created_at": "2026-05-02T11:04:17.000Z",
"updated_at": "2026-08-10T14:32:05.123Z"
}{
"error": {
"code": "bad_request",
"message": "The request is malformed."
}
}{
"error": {
"code": "unauthorized",
"message": "Authentication is required. Send a valid Bearer token in the Authorization header."
}
}{
"error": {
"code": "forbidden",
"message": "This account is suspended."
}
}{
"error": {
"code": "not_found",
"message": "Resource could not be found."
}
}{
"error": {
"code": "validation_failed",
"message": "The request payload is invalid.",
"details": [
{
"field": "actions",
"code": "unsupported",
"message": "Unsupported macro actions: delete_conversation. Supported actions: send_message, add_private_note, add_label, remove_label, assign_team, remove_assigned_team, assign_agent, mute_conversation, change_status, change_priority, resolve_conversation, snooze_conversation, open_conversation, mark_conversation_as_pending."
}
]
}
}{
"message": "API rate limit exceeded"
}{
"error": {
"code": "internal_error",
"message": "An unexpected error occurred. Please try again later."
}
}Create a macro
Open to any account member. name and actions are required; each action’s action_name must be one of the values on the MacroAction schema — anything else is refused as validation_failed, naming the unsupported actions.
An agent’s macro is always forced to visibility: personal, whatever the payload sends. Only an administrator can create a global one.
curl --request POST \
--url https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/macros \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'cloudchat-instance: <cloudchat-instance>' \
--data '
{
"macro": {
"name": "Refund flow",
"actions": [
{
"action_name": "add_label",
"action_params": [
"refund"
]
}
],
"visibility": "global"
}
}
'import requests
url = "https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/macros"
payload = { "macro": {
"name": "Refund flow",
"actions": [
{
"action_name": "add_label",
"action_params": ["refund"]
}
],
"visibility": "global"
} }
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({
macro: {
name: 'Refund flow',
actions: [{action_name: 'add_label', action_params: ['refund']}],
visibility: 'global'
}
})
};
fetch('https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/macros', 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}/macros",
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([
'macro' => [
'name' => 'Refund flow',
'actions' => [
[
'action_name' => 'add_label',
'action_params' => [
'refund'
]
]
],
'visibility' => 'global'
]
]),
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}/macros"
payload := strings.NewReader("{\n \"macro\": {\n \"name\": \"Refund flow\",\n \"actions\": [\n {\n \"action_name\": \"add_label\",\n \"action_params\": [\n \"refund\"\n ]\n }\n ],\n \"visibility\": \"global\"\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}/macros")
.header("cloudchat-instance", "<cloudchat-instance>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"macro\": {\n \"name\": \"Refund flow\",\n \"actions\": [\n {\n \"action_name\": \"add_label\",\n \"action_params\": [\n \"refund\"\n ]\n }\n ],\n \"visibility\": \"global\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/macros")
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 \"macro\": {\n \"name\": \"Refund flow\",\n \"actions\": [\n {\n \"action_name\": \"add_label\",\n \"action_params\": [\n \"refund\"\n ]\n }\n ],\n \"visibility\": \"global\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 21,
"name": "Refund flow",
"visibility": "global",
"actions": [
{
"action_name": "add_label",
"action_params": [
"refund"
]
}
],
"created_at": "2026-05-02T11:04:17.000Z",
"updated_at": "2026-08-10T14:32:05.123Z"
}{
"error": {
"code": "bad_request",
"message": "The request is malformed."
}
}{
"error": {
"code": "unauthorized",
"message": "Authentication is required. Send a valid Bearer token in the Authorization header."
}
}{
"error": {
"code": "forbidden",
"message": "This account is suspended."
}
}{
"error": {
"code": "not_found",
"message": "Resource could not be found."
}
}{
"error": {
"code": "validation_failed",
"message": "The request payload is invalid.",
"details": [
{
"field": "actions",
"code": "unsupported",
"message": "Unsupported macro actions: delete_conversation. Supported actions: send_message, add_private_note, add_label, remove_label, assign_team, remove_assigned_team, assign_agent, mute_conversation, change_status, change_priority, resolve_conversation, snooze_conversation, open_conversation, mark_conversation_as_pending."
}
]
}
}{
"message": "API rate limit exceeded"
}{
"error": {
"code": "internal_error",
"message": "An unexpected error occurred. Please try again later."
}
}Authorizations
The id_token from POST /auth/v1/signin, sent as Authorization: Bearer <id_token>. Not the access_token — that one does not carry the identity Cloud Chat authorizes on.
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
The macro goes under a macro wrapper. Open to any account member — an agent's macro is always forced to visibility: personal regardless of what is sent.
Show child attributes
Show child attributes
Response
Created.
A macro of the account — either global (visible to everyone) or personal (visible only to its author).
21
"Refund flow"
global, personal "global"
Show child attributes
Show child attributes
"2026-05-02T11:04:17.000Z"
"2026-08-10T14:32:05.123Z"