curl --request PATCH \
--url https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/portals/{portalSlug} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'cloudchat-instance: <cloudchat-instance>' \
--data '
{
"portal": {
"name": "Acme Help",
"allowed_locales": [
"pt_BR",
"en"
]
}
}
'import requests
url = "https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/portals/{portalSlug}"
payload = { "portal": {
"name": "Acme Help",
"allowed_locales": ["pt_BR", "en"]
} }
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({portal: {name: 'Acme Help', allowed_locales: ['pt_BR', 'en']}})
};
fetch('https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/portals/{portalSlug}', 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}/portals/{portalSlug}",
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([
'portal' => [
'name' => 'Acme Help',
'allowed_locales' => [
'pt_BR',
'en'
]
]
]),
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}/portals/{portalSlug}"
payload := strings.NewReader("{\n \"portal\": {\n \"name\": \"Acme Help\",\n \"allowed_locales\": [\n \"pt_BR\",\n \"en\"\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}/portals/{portalSlug}")
.header("cloudchat-instance", "<cloudchat-instance>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"portal\": {\n \"name\": \"Acme Help\",\n \"allowed_locales\": [\n \"pt_BR\",\n \"en\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/portals/{portalSlug}")
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 \"portal\": {\n \"name\": \"Acme Help\",\n \"allowed_locales\": [\n \"pt_BR\",\n \"en\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 9,
"slug": "acme-help",
"name": "Acme Help",
"default_locale": "pt_BR",
"allowed_locales": [
"pt_BR",
"en"
],
"archived": false,
"created_at": "2026-08-19T18:02:11.004Z",
"updated_at": "2026-08-19T18:44:03.771Z"
}{
"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": "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": "short_code",
"code": "taken",
"message": "has already been taken"
}
]
}
}{
"message": "API rate limit exceeded"
}{
"error": {
"code": "internal_error",
"message": "An unexpected error occurred. Please try again later."
}
}Update a portal
Change a portal’s name, the locales it may hold content in, or its logo. Send only the fields you are changing; a body with none of them is a 400.
This is where a portal becomes usable in more than one language: allowed_locales is what a category’s locale is checked against. Note that it replaces the stored list instead of adding to it — the field description spells out both refusals you can expect.
Requires being an administrator of the account.
curl --request PATCH \
--url https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/portals/{portalSlug} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'cloudchat-instance: <cloudchat-instance>' \
--data '
{
"portal": {
"name": "Acme Help",
"allowed_locales": [
"pt_BR",
"en"
]
}
}
'import requests
url = "https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/portals/{portalSlug}"
payload = { "portal": {
"name": "Acme Help",
"allowed_locales": ["pt_BR", "en"]
} }
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({portal: {name: 'Acme Help', allowed_locales: ['pt_BR', 'en']}})
};
fetch('https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/portals/{portalSlug}', 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}/portals/{portalSlug}",
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([
'portal' => [
'name' => 'Acme Help',
'allowed_locales' => [
'pt_BR',
'en'
]
]
]),
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}/portals/{portalSlug}"
payload := strings.NewReader("{\n \"portal\": {\n \"name\": \"Acme Help\",\n \"allowed_locales\": [\n \"pt_BR\",\n \"en\"\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}/portals/{portalSlug}")
.header("cloudchat-instance", "<cloudchat-instance>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"portal\": {\n \"name\": \"Acme Help\",\n \"allowed_locales\": [\n \"pt_BR\",\n \"en\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/portals/{portalSlug}")
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 \"portal\": {\n \"name\": \"Acme Help\",\n \"allowed_locales\": [\n \"pt_BR\",\n \"en\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 9,
"slug": "acme-help",
"name": "Acme Help",
"default_locale": "pt_BR",
"allowed_locales": [
"pt_BR",
"en"
],
"archived": false,
"created_at": "2026-08-19T18:02:11.004Z",
"updated_at": "2026-08-19T18:44:03.771Z"
}{
"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": "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": "short_code",
"code": "taken",
"message": "has already been taken"
}
]
}
}{
"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
The portal's slug — the URL-safe handle you see in its public address (/hc/<slug>/...), not a numeric id. List portals returns every slug on the account. Note the asymmetry: portals are addressed by slug, articles by numeric id.
"acme-help"
Body
The fields to change go under a portal wrapper; send only the ones you are changing, and at least one of them. slug is absent on purpose: it forms the public URL of every published article, so it is immutable. Archiving the portal, binding it to a web widget and setting a custom domain are not exposed here either — those stay in the dashboard.
Show child attributes
Show child attributes
Response
The portal as stored.
A help center site of the account.
Numeric id, informational only — every help center endpoint addresses the portal by slug.
3
What goes in the portalSlug path segment of the other help center endpoints.
"acme-help"
Display name of the help center.
"Acme Help Center"
Locale used when nothing more specific applies — including as the translation target for an article without a category.
"en"
Locales the portal can hold content in. A category (and through it, an article) must live in one of these.
["en", "pt_BR"]
An archived portal is no longer served to visitors.
false
"2026-05-02T11:04:17.000Z"
"2026-08-10T14:32:05.123Z"