curl --request PATCH \
--url https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/inboxes/{inboxId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'cloudchat-instance: <cloudchat-instance>' \
--data @- <<EOF
{
"inbox": {
"name": "Support WhatsApp",
"greeting_enabled": true,
"greeting_message": "Thanks for reaching out! We'll be with you shortly.",
"working_hours_enabled": true,
"out_of_office_message": "We're closed right now — we'll reply as soon as we're back.",
"timezone": "America/Sao_Paulo",
"csat_survey_enabled": true,
"working_hours": [
{
"day_of_week": 1,
"closed_all_day": false,
"open_all_day": false,
"open_hour": 9,
"open_minutes": 0,
"close_hour": 18,
"close_minutes": 0
}
]
}
}
EOFimport requests
url = "https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/inboxes/{inboxId}"
payload = { "inbox": {
"name": "Support WhatsApp",
"greeting_enabled": True,
"greeting_message": "Thanks for reaching out! We'll be with you shortly.",
"working_hours_enabled": True,
"out_of_office_message": "We're closed right now — we'll reply as soon as we're back.",
"timezone": "America/Sao_Paulo",
"csat_survey_enabled": True,
"working_hours": [
{
"day_of_week": 1,
"closed_all_day": False,
"open_all_day": False,
"open_hour": 9,
"open_minutes": 0,
"close_hour": 18,
"close_minutes": 0
}
]
} }
headers = {
"cloudchat-instance": "<cloudchat-instance>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'cloudchat-instance': '<cloudchat-instance>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
inbox: {
name: 'Support WhatsApp',
greeting_enabled: true,
greeting_message: 'Thanks for reaching out! We\'ll be with you shortly.',
working_hours_enabled: true,
out_of_office_message: 'We\'re closed right now — we\'ll reply as soon as we\'re back.',
timezone: 'America/Sao_Paulo',
csat_survey_enabled: true,
working_hours: [
{
day_of_week: 1,
closed_all_day: false,
open_all_day: false,
open_hour: 9,
open_minutes: 0,
close_hour: 18,
close_minutes: 0
}
]
}
})
};
fetch('https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/inboxes/{inboxId}', 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}/inboxes/{inboxId}",
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([
'inbox' => [
'name' => 'Support WhatsApp',
'greeting_enabled' => true,
'greeting_message' => 'Thanks for reaching out! We\'ll be with you shortly.',
'working_hours_enabled' => true,
'out_of_office_message' => 'We\'re closed right now — we\'ll reply as soon as we\'re back.',
'timezone' => 'America/Sao_Paulo',
'csat_survey_enabled' => true,
'working_hours' => [
[
'day_of_week' => 1,
'closed_all_day' => false,
'open_all_day' => false,
'open_hour' => 9,
'open_minutes' => 0,
'close_hour' => 18,
'close_minutes' => 0
]
]
]
]),
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}/inboxes/{inboxId}"
payload := strings.NewReader("{\n \"inbox\": {\n \"name\": \"Support WhatsApp\",\n \"greeting_enabled\": true,\n \"greeting_message\": \"Thanks for reaching out! We'll be with you shortly.\",\n \"working_hours_enabled\": true,\n \"out_of_office_message\": \"We're closed right now — we'll reply as soon as we're back.\",\n \"timezone\": \"America/Sao_Paulo\",\n \"csat_survey_enabled\": true,\n \"working_hours\": [\n {\n \"day_of_week\": 1,\n \"closed_all_day\": false,\n \"open_all_day\": false,\n \"open_hour\": 9,\n \"open_minutes\": 0,\n \"close_hour\": 18,\n \"close_minutes\": 0\n }\n ]\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/inboxes/{inboxId}")
.header("cloudchat-instance", "<cloudchat-instance>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"inbox\": {\n \"name\": \"Support WhatsApp\",\n \"greeting_enabled\": true,\n \"greeting_message\": \"Thanks for reaching out! We'll be with you shortly.\",\n \"working_hours_enabled\": true,\n \"out_of_office_message\": \"We're closed right now — we'll reply as soon as we're back.\",\n \"timezone\": \"America/Sao_Paulo\",\n \"csat_survey_enabled\": true,\n \"working_hours\": [\n {\n \"day_of_week\": 1,\n \"closed_all_day\": false,\n \"open_all_day\": false,\n \"open_hour\": 9,\n \"open_minutes\": 0,\n \"close_hour\": 18,\n \"close_minutes\": 0\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/inboxes/{inboxId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["cloudchat-instance"] = '<cloudchat-instance>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"inbox\": {\n \"name\": \"Support WhatsApp\",\n \"greeting_enabled\": true,\n \"greeting_message\": \"Thanks for reaching out! We'll be with you shortly.\",\n \"working_hours_enabled\": true,\n \"out_of_office_message\": \"We're closed right now — we'll reply as soon as we're back.\",\n \"timezone\": \"America/Sao_Paulo\",\n \"csat_survey_enabled\": true,\n \"working_hours\": [\n {\n \"day_of_week\": 1,\n \"closed_all_day\": false,\n \"open_all_day\": false,\n \"open_hour\": 9,\n \"open_minutes\": 0,\n \"close_hour\": 18,\n \"close_minutes\": 0\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 3,
"name": "Support WhatsApp",
"channel_type": "Channel::Whatsapp",
"greeting_enabled": true,
"greeting_message": "Thanks for reaching out! We'll be with you shortly.",
"working_hours_enabled": true,
"out_of_office_message": "We're closed right now — we'll reply as soon as we're back.",
"timezone": "America/Sao_Paulo",
"csat_survey_enabled": true,
"enable_auto_assignment": true,
"allow_messages_after_resolved": true,
"lock_to_single_conversation": false,
"created_at": "2026-05-02T11:04:17.000Z",
"updated_at": "2026-08-10T14:32:05.123Z"
}{
"error": {
"code": "bad_request",
"message": "Provide at least one of name, greeting_enabled, greeting_message, working_hours_enabled, out_of_office_message, timezone, working_hours or csat_survey_enabled inside inbox."
}
}{
"error": {
"code": "unauthorized",
"message": "Authentication is required. Send a valid Bearer token in the Authorization header."
}
}{
"error": {
"code": "forbidden",
"message": "You are not allowed to perform this action."
}
}{
"error": {
"code": "not_found",
"message": "Resource could not be found."
}
}{
"error": {
"code": "validation_failed",
"message": "The request payload is invalid.",
"details": [
{
"field": "working_hours[0].close_hour",
"code": "invalid",
"message": "Closing time cannot be before opening time"
}
]
}
}{
"message": "API rate limit exceeded"
}{
"error": {
"code": "internal_error",
"message": "An unexpected error occurred. Please try again later."
}
}Update an inbox's settings
Administrator only. Change the operating settings of an inbox: its name, the greeting, the working hours (flag, timezone, out-of-office message and weekly schedule) and the CSAT survey toggle. What is not sent stays untouched, and everything you send is applied together or not at all.
The greeting and the out-of-office message are texts Cloud Chat sends to the end customer exactly as written. Changing the working hours or the timezone changes when a conversation counts as outside business hours: it decides when customers receive the out-of-office message and how business-hours reports are measured.
The channel itself (connection, credentials, provider), webhooks, avatar, auto-assignment, bots and every other inbox setting are not editable through the API. They are changed on the Cloud Chat screen, and a payload that carries any of them is refused with a 422 that names the field.
The response is the same Inbox that GET returns, which does not include the weekly schedule. To change a day, send the whole day.
curl --request PATCH \
--url https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/inboxes/{inboxId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'cloudchat-instance: <cloudchat-instance>' \
--data @- <<EOF
{
"inbox": {
"name": "Support WhatsApp",
"greeting_enabled": true,
"greeting_message": "Thanks for reaching out! We'll be with you shortly.",
"working_hours_enabled": true,
"out_of_office_message": "We're closed right now — we'll reply as soon as we're back.",
"timezone": "America/Sao_Paulo",
"csat_survey_enabled": true,
"working_hours": [
{
"day_of_week": 1,
"closed_all_day": false,
"open_all_day": false,
"open_hour": 9,
"open_minutes": 0,
"close_hour": 18,
"close_minutes": 0
}
]
}
}
EOFimport requests
url = "https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/inboxes/{inboxId}"
payload = { "inbox": {
"name": "Support WhatsApp",
"greeting_enabled": True,
"greeting_message": "Thanks for reaching out! We'll be with you shortly.",
"working_hours_enabled": True,
"out_of_office_message": "We're closed right now — we'll reply as soon as we're back.",
"timezone": "America/Sao_Paulo",
"csat_survey_enabled": True,
"working_hours": [
{
"day_of_week": 1,
"closed_all_day": False,
"open_all_day": False,
"open_hour": 9,
"open_minutes": 0,
"close_hour": 18,
"close_minutes": 0
}
]
} }
headers = {
"cloudchat-instance": "<cloudchat-instance>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'cloudchat-instance': '<cloudchat-instance>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
inbox: {
name: 'Support WhatsApp',
greeting_enabled: true,
greeting_message: 'Thanks for reaching out! We\'ll be with you shortly.',
working_hours_enabled: true,
out_of_office_message: 'We\'re closed right now — we\'ll reply as soon as we\'re back.',
timezone: 'America/Sao_Paulo',
csat_survey_enabled: true,
working_hours: [
{
day_of_week: 1,
closed_all_day: false,
open_all_day: false,
open_hour: 9,
open_minutes: 0,
close_hour: 18,
close_minutes: 0
}
]
}
})
};
fetch('https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/inboxes/{inboxId}', 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}/inboxes/{inboxId}",
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([
'inbox' => [
'name' => 'Support WhatsApp',
'greeting_enabled' => true,
'greeting_message' => 'Thanks for reaching out! We\'ll be with you shortly.',
'working_hours_enabled' => true,
'out_of_office_message' => 'We\'re closed right now — we\'ll reply as soon as we\'re back.',
'timezone' => 'America/Sao_Paulo',
'csat_survey_enabled' => true,
'working_hours' => [
[
'day_of_week' => 1,
'closed_all_day' => false,
'open_all_day' => false,
'open_hour' => 9,
'open_minutes' => 0,
'close_hour' => 18,
'close_minutes' => 0
]
]
]
]),
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}/inboxes/{inboxId}"
payload := strings.NewReader("{\n \"inbox\": {\n \"name\": \"Support WhatsApp\",\n \"greeting_enabled\": true,\n \"greeting_message\": \"Thanks for reaching out! We'll be with you shortly.\",\n \"working_hours_enabled\": true,\n \"out_of_office_message\": \"We're closed right now — we'll reply as soon as we're back.\",\n \"timezone\": \"America/Sao_Paulo\",\n \"csat_survey_enabled\": true,\n \"working_hours\": [\n {\n \"day_of_week\": 1,\n \"closed_all_day\": false,\n \"open_all_day\": false,\n \"open_hour\": 9,\n \"open_minutes\": 0,\n \"close_hour\": 18,\n \"close_minutes\": 0\n }\n ]\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/inboxes/{inboxId}")
.header("cloudchat-instance", "<cloudchat-instance>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"inbox\": {\n \"name\": \"Support WhatsApp\",\n \"greeting_enabled\": true,\n \"greeting_message\": \"Thanks for reaching out! We'll be with you shortly.\",\n \"working_hours_enabled\": true,\n \"out_of_office_message\": \"We're closed right now — we'll reply as soon as we're back.\",\n \"timezone\": \"America/Sao_Paulo\",\n \"csat_survey_enabled\": true,\n \"working_hours\": [\n {\n \"day_of_week\": 1,\n \"closed_all_day\": false,\n \"open_all_day\": false,\n \"open_hour\": 9,\n \"open_minutes\": 0,\n \"close_hour\": 18,\n \"close_minutes\": 0\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/inboxes/{inboxId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["cloudchat-instance"] = '<cloudchat-instance>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"inbox\": {\n \"name\": \"Support WhatsApp\",\n \"greeting_enabled\": true,\n \"greeting_message\": \"Thanks for reaching out! We'll be with you shortly.\",\n \"working_hours_enabled\": true,\n \"out_of_office_message\": \"We're closed right now — we'll reply as soon as we're back.\",\n \"timezone\": \"America/Sao_Paulo\",\n \"csat_survey_enabled\": true,\n \"working_hours\": [\n {\n \"day_of_week\": 1,\n \"closed_all_day\": false,\n \"open_all_day\": false,\n \"open_hour\": 9,\n \"open_minutes\": 0,\n \"close_hour\": 18,\n \"close_minutes\": 0\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 3,
"name": "Support WhatsApp",
"channel_type": "Channel::Whatsapp",
"greeting_enabled": true,
"greeting_message": "Thanks for reaching out! We'll be with you shortly.",
"working_hours_enabled": true,
"out_of_office_message": "We're closed right now — we'll reply as soon as we're back.",
"timezone": "America/Sao_Paulo",
"csat_survey_enabled": true,
"enable_auto_assignment": true,
"allow_messages_after_resolved": true,
"lock_to_single_conversation": false,
"created_at": "2026-05-02T11:04:17.000Z",
"updated_at": "2026-08-10T14:32:05.123Z"
}{
"error": {
"code": "bad_request",
"message": "Provide at least one of name, greeting_enabled, greeting_message, working_hours_enabled, out_of_office_message, timezone, working_hours or csat_survey_enabled inside inbox."
}
}{
"error": {
"code": "unauthorized",
"message": "Authentication is required. Send a valid Bearer token in the Authorization header."
}
}{
"error": {
"code": "forbidden",
"message": "You are not allowed to perform this action."
}
}{
"error": {
"code": "not_found",
"message": "Resource could not be found."
}
}{
"error": {
"code": "validation_failed",
"message": "The request payload is invalid.",
"details": [
{
"field": "working_hours[0].close_hour",
"code": "invalid",
"message": "Closing time cannot be before opening time"
}
]
}
}{
"message": "API rate limit exceeded"
}{
"error": {
"code": "internal_error",
"message": "An unexpected error occurred. Please try again later."
}
}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 inbox after the update.
An inbox of the account. Configuration only — no channel credential (access token, phone number id, API key, or similar) is ever included in this payload, on any channel type.