package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/conversations/{conversationId}/notes"
payload := strings.NewReader("{\n \"content\": \"Customer asked to be called back after 3 pm.\"\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}/conversations/{conversationId}/notes")
.header("cloudchat-instance", "<cloudchat-instance>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"content\": \"Customer asked to be called back after 3 pm.\"\n}")
.asString();
require 'uri'
require 'net/http'
url = URI("https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/conversations/{conversationId}/notes")
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 \"content\": \"Customer asked to be called back after 3 pm.\"\n}"
response = http.request(request)
puts response.read_body
{
"error": {
"code": "bad_request",
"message": "The request is malformed.",
"details": [
{
"field": "content",
"code": "invalid",
"message": "The value must be a single scalar, not an array or object."
}
]
}
}
{
"error": {
"code": "unauthorized",
"message": "Authentication is required. Send a valid Bearer token in the Authorization header."
}
}
{
"error": {
"code": "not_found",
"message": "Resource could not be found."
}
}
{
"error": {
"code": "conflict",
"message": "The request conflicts with the current state of the resource.",
"details": [
{
"field": "conversation",
"code": "merged",
"message": "This conversation was merged into another one and is read-only. Work on the conversation it was merged into."
}
]
}
}
{
"error": {
"code": "validation_failed",
"message": "The request payload is invalid.",
"details": [
{
"field": "content",
"code": "blank",
"message": "Provide the note text in content. It cannot be blank."
}
]
}
}
Add an internal note to a conversation. The note is always private: the customer never sees it and it is never sent through the channel. Its author is the user the token belongs to — nothing in the body can choose another author or make the note public. Plain text only, no attachments; replying to the customer is not part of this endpoint.
Notes can be added to a resolved conversation and do not reopen it. Mention links written in the text notify the agents they point to, as in the dashboard. The response has the same shape List conversation messages returns, with private: true. Visibility follows the same rule as the list: an administrator token reaches every inbox of the account, an agent token only its own inbox memberships. A conversation outside that reach answers 404, indistinguishable from an id that does not exist. A conversation merged into another one, or mirrored from another helpdesk, is read-only and answers 409.
POST
/
v1
/
accounts
/
{accountId}
/
conversations
/
{conversationId}
/
notes
Add an internal note to a conversation
curl --request POST \ --url https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/conversations/{conversationId}/notes \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'cloudchat-instance: <cloudchat-instance>' \ --data '{ "content": "Customer asked to be called back after 3 pm."}'
import requests
url = "https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/conversations/{conversationId}/notes"
payload = { "content": "Customer asked to be called back after 3 pm." }
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({content: 'Customer asked to be called back after 3 pm.'})
};
fetch('https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/conversations/{conversationId}/notes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/conversations/{conversationId}/notes"
payload := strings.NewReader("{\n \"content\": \"Customer asked to be called back after 3 pm.\"\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}/conversations/{conversationId}/notes")
.header("cloudchat-instance", "<cloudchat-instance>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"content\": \"Customer asked to be called back after 3 pm.\"\n}")
.asString();
require 'uri'
require 'net/http'
url = URI("https://api.cloudhumans.com/cloudchat/v1/accounts/{accountId}/conversations/{conversationId}/notes")
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 \"content\": \"Customer asked to be called back after 3 pm.\"\n}"
response = http.request(request)
puts response.read_body
{
"error": {
"code": "bad_request",
"message": "The request is malformed.",
"details": [
{
"field": "content",
"code": "invalid",
"message": "The value must be a single scalar, not an array or object."
}
]
}
}
{
"error": {
"code": "unauthorized",
"message": "Authentication is required. Send a valid Bearer token in the Authorization header."
}
}
{
"error": {
"code": "not_found",
"message": "Resource could not be found."
}
}
{
"error": {
"code": "conflict",
"message": "The request conflicts with the current state of the resource.",
"details": [
{
"field": "conversation",
"code": "merged",
"message": "This conversation was merged into another one and is read-only. Work on the conversation it was merged into."
}
]
}
}
{
"error": {
"code": "validation_failed",
"message": "The request payload is invalid.",
"details": [
{
"field": "content",
"code": "blank",
"message": "Provide the note text in content. It cannot be blank."
}
]
}
}
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
cloudchat-instance
integer
required
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.
Example:
1
Path Parameters
accountId
integer
required
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.
Example:
1
conversationId
integer
required
The conversation's display_id — the number shown in the dashboard URL and delivered in webhooks. It is never the internal database id.
Example:
1042
Body
application/json
The internal note to add.
content
string
required
The note text, plain text. It is stored as a private note: the customer never sees it. Blank text is a 422.
Example:
"Customer asked to be called back after 3 pm."
Response
The note as stored.
A single message of a conversation. Attachments and content_attributes are not exposed in this version — only the fields listed below.
id
integer
required
Stable identifier, unique within the instance.
Example:
58211
uuid
string | null
required
The message's canonical id, globally unique. For ClaudIA's reply and for the customer message that started the turn, it is the messageId the ClaudIA API takes in Get a message trace, where the numeric id above does not resolve. null on older messages stored without one.
Example:
"8b0e5f3a-6c2d-4e71-9f4a-2d1c7b9e0a53"
content
string | null
required
The message text. null on some activity or attachment-only messages.
Example:
"Thanks, that solved it!"
message_type
enum<string>
required
Who originated it and how — incoming from the contact, outgoing from an agent or bot, activity a system event (status/assignment change), template an outbound message template (WhatsApp, etc).
Available options:
incoming,
outgoing,
activity,
template
Example:
"outgoing"
content_type
enum<string>
required
How the dashboard renders the message body. text covers the overwhelming majority of messages; the rest are the interactive/bot content types (input_select, cards, form, article, input_csat, and similar).
Available options:
text,
input_text,
input_textarea,
input_email,
input_select,
cards,
form,
article,
incoming_email,
input_csat,
integrations,
sticker,
follow_up,
closing_message
Example:
"text"
private
boolean
required
true for a private note — visible only to agents, never sent to the contact. This endpoint returns private notes like any other message; filter them out client-side if you don't want them.
Example:
false
status
enum<string> | null
required
Delivery status on the channel. null on message types that don't track delivery (e.g. activity).
Available options:
sent,
delivered,
read,
failed
Example:
"delivered"
sender
object | null
required
Who sent the message. null on an activity message (status changes, assignment changes, and the like), which has no author.
A hidden admin — the platform's own support user, occasionally the sender of a system message — reports type: "user" with id: null and a masked name, indistinguishable from any other masking. There is no way to resolve a hidden admin's real id through this API.
Show child attributes
created_at
string<date-time>
required
When it was created. ISO 8601, always UTC, milliseconds included.
Example:
"2026-08-13T19:09:51.482Z"
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Cloud Chat","colors":{"primary":"#EF7221","light":"#FF9D5C","dark":"#D65E10"},"logo":{"light":"https://mintcdn.com/cloud-humans/GHbxWTY81Qa4762I/logo/light.svg?fit=max\u0026auto=format\u0026n=GHbxWTY81Qa4762I\u0026q=85\u0026s=2899d32cd5c5f8adff5bb4390125f626","dark":"https://mintcdn.com/cloud-humans/GHbxWTY81Qa4762I/logo/dark.svg?fit=max\u0026auto=format\u0026n=GHbxWTY81Qa4762I\u0026q=85\u0026s=95d8350f3dade95801b6c310d5ba597f"},"favicon":"https://mintcdn.com/cloud-humans/T7XxBi09ex74abIC/favicon.svg?fit=max\u0026auto=format\u0026n=T7XxBi09ex74abIC\u0026q=85\u0026s=6b1379d1ea0f266d6ca12eb1f8ccbf77","fonts":{"family":"Inter"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cloud-humans","hasAudioNarration":false,"actualSubdomain":"cloud-humans","customDomains":["docs.cloudhumans.com"],"gitSource":{"type":"github","owner":"cloudhumans","repo":"dev-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6aff212b5735af7f41d07425","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"API Reference","count":190},{"language":"default","tag":"Cloud Chat","count":129},{"language":"default","tag":"Claudia","count":66},{"language":"default","tag":"Guides","count":32},{"language":"default","tag":"Data Export","count":27},{"language":"default","tag":"Table Catalog","count":19},{"language":"default","tag":"Agents","count":18},{"language":"default","tag":"Help Center","count":15},{"language":"default","tag":"Conversations","count":14},{"language":"default","tag":"Controlled Flows","count":14}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/cloudchat/endpoints/add-a-conversation-note","slug":"/api-reference/cloudchat/endpoints/add-a-conversation-note","pageMetadata":{"title":"Add an internal note to a conversation","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/conversations/{conversationId}/notes","description":"Add an internal note to a conversation. The note is always private: the customer never sees it and it is never sent through the channel. Its author is the user the token belongs to — nothing in the body can choose another author or make the note public. Plain text only, no attachments; replying to the customer is not part of this endpoint.\n\nNotes can be added to a resolved conversation and do not reopen it. Mention links written in the text notify the agents they point to, as in the dashboard. The response has the same shape [List conversation messages](/api-reference/cloudchat/endpoints/list-conversation-messages) returns, with `private: true`. Visibility follows the same rule as the list: an administrator token reaches every inbox of the account, an agent token only its own inbox memberships. A conversation outside that reach answers 404, indistinguishable from an id that does not exist. A conversation merged into another one, or mirrored from another helpdesk, is read-only and answers 409.","href":"/api-reference/cloudchat/endpoints/add-a-conversation-note"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Add an internal note to a conversation. The note is always private: the customer never sees it and it is never sent through the channel. Its author is the user the token belongs to — nothing in the body can choose another author or make the note public. Plain text only, no attachments; replying to the customer is not part of this endpoint.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Notes can be added to a resolved conversation and do not reopen it. Mention links written in the text notify the agents they point to, as in the dashboard. The response has the same shape \", _jsx(_components.a, {\n href: \"/api-reference/cloudchat/endpoints/list-conversation-messages\",\n children: \"List conversation messages\"\n }), \" returns, with \", _jsx(_components.code, {\n children: \"private: true\"\n }), \". Visibility follows the same rule as the list: an administrator token reaches every inbox of the account, an agent token only its own inbox memberships. A conversation outside that reach answers 404, indistinguishable from an id that does not exist. A conversation merged into another one, or mirrored from another helpdesk, is read-only and answers 409.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];const CloudChatYourValues=()=>{const _components={a:`a`,..._provideComponents()};const STORAGE_KEY=`cloudchat-api-selected-account`;const CREDENTIALS_HREF=`/api-reference/cloudchat/credentials`;const[saved,setSaved]=useState(null);const[ready,setReady]=useState(false);useEffect(()=>{let value=null;try{const raw=window.localStorage.getItem(STORAGE_KEY);if(raw){const parsed=JSON.parse(raw);if(parsed\u0026\u0026parsed.instance\u0026\u0026parsed.account){value={instance:String(parsed.instance),account:String(parsed.account),name:typeof parsed.name===`string`\u0026\u0026parsed.name?parsed.name:null}}}}catch(error){value=null}setSaved(value);setReady(true)},[]);const shell=`not-prose rounded-xl border border-gray-200 dark:border-white/10 bg-gray-50 dark:bg-white/5 px-4 py-3 mb-6`;if(!ready||!saved){return _jsx(`div`,{className:`not-prose mint-rounded-xl mint-border mint-border-gray-200 dark:mint-border-white/10 mint-bg-gray-50 dark:mint-bg-white/5 mint-px-4 mint-py-3 mint-mb-6`,children:_jsxs(`p`,{className:`mint-text-sm mint-text-gray-600 dark:mint-text-gray-400`,children:[`Every request below needs your `,_jsx(`code`,{children:`cloudchat-instance`}),` header and your account id.`,` `,_jsx(_components.a,{href:CREDENTIALS_HREF,className:`mint-underline mint-underline-offset-2`,children:`Paste your token`}),` `,`and they will show up here, ready to copy.`]})})}return _jsx(`div`,{className:`not-prose mint-rounded-xl mint-border mint-border-gray-200 dark:mint-border-white/10 mint-bg-gray-50 dark:mint-bg-white/5 mint-px-4 mint-py-3 mint-mb-6`,children:_jsxs(`div`,{className:`mint-flex mint-flex-wrap mint-items-baseline mint-gap-x-6 mint-gap-y-2`,children:[_jsxs(`div`,{children:[_jsx(`span`,{className:`mint-text-xs mint-uppercase mint-tracking-wide mint-text-gray-500 dark:mint-text-gray-400`,children:`cloudchat-instance`}),_jsx(`span`,{className:`mint-ml-2 mint-font-mono mint-text-sm mint-text-gray-900 dark:mint-text-gray-100`,children:saved.instance})]}),_jsxs(`div`,{children:[_jsx(`span`,{className:`mint-text-xs mint-uppercase mint-tracking-wide mint-text-gray-500 dark:mint-text-gray-400`,children:`accountId`}),_jsx(`span`,{className:`mint-ml-2 mint-font-mono mint-text-sm mint-text-gray-900 dark:mint-text-gray-100`,children:saved.account})]}),saved.name\u0026\u0026_jsx(`span`,{className:`mint-text-sm mint-text-gray-600 dark:mint-text-gray-400`,children:saved.name}),_jsx(_components.a,{href:CREDENTIALS_HREF,className:`mint-text-sm mint-text-gray-500 dark:mint-text-gray-400 mint-underline mint-underline-offset-2`,children:`Change`})]})})};function _createMdxContent(props){const{_MdxComponentBoundary}={..._provideComponents(),...props.components};if(!_MdxComponentBoundary)_missingMdxReference(`_MdxComponentBoundary`,true);return _jsx(_MdxComponentBoundary,{name:`CloudChatYourValues`,children:_jsx(CloudChatYourValues,{})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{CloudChatYourValues,default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Add an internal note to a conversation","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/conversations/{conversationId}/notes","description":"Add an internal note to a conversation. The note is always private: the customer never sees it and it is never sent through the channel. Its author is the user the token belongs to — nothing in the body can choose another author or make the note public. Plain text only, no attachments; replying to the customer is not part of this endpoint.\n\nNotes can be added to a resolved conversation and do not reopen it. Mention links written in the text notify the agents they point to, as in the dashboard. The response has the same shape [List conversation messages](/api-reference/cloudchat/endpoints/list-conversation-messages) returns, with `private: true`. Visibility follows the same rule as the list: an administrator token reaches every inbox of the account, an agent token only its own inbox memberships. A conversation outside that reach answers 404, indistinguishable from an id that does not exist. A conversation merged into another one, or mirrored from another helpdesk, is read-only and answers 409.","href":"/api-reference/cloudchat/endpoints/add-a-conversation-note"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[27,38,""],[139,2658,"null;function _creat"]]},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"dynamicCss":".mint-mb-6 {\n margin-bottom: 1.5rem\n}\n.mint-ml-2 {\n margin-left: 0.5rem\n}\n.mint-flex {\n display: flex\n}\n.mint-flex-wrap {\n flex-wrap: wrap\n}\n.mint-items-baseline {\n align-items: baseline\n}\n.mint-gap-x-6 {\n column-gap: 1.5rem\n}\n.mint-gap-y-2 {\n row-gap: 0.5rem\n}\n.mint-rounded-xl {\n border-radius: 0.75rem\n}\n.mint-border {\n border-width: 1px\n}\n.mint-border-gray-200 {\n --tw-border-opacity: 1;\n border-color: rgb(229 231 235 / var(--tw-border-opacity, 1))\n}\n.mint-bg-gray-50 {\n --tw-bg-opacity: 1;\n background-color: rgb(249 250 251 / var(--tw-bg-opacity, 1))\n}\n.mint-px-4 {\n padding-left: 1rem;\n padding-right: 1rem\n}\n.mint-py-3 {\n padding-top: 0.75rem;\n padding-bottom: 0.75rem\n}\n.mint-font-mono {\n font-family: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, \"Liberation Mono\", \"Courier New\", monospace\n}\n.mint-text-sm {\n font-size: 0.875rem;\n line-height: 1.25rem\n}\n.mint-text-xs {\n font-size: 0.75rem;\n line-height: 1rem\n}\n.mint-uppercase {\n text-transform: uppercase\n}\n.mint-tracking-wide {\n letter-spacing: 0.025em\n}\n.mint-text-gray-500 {\n --tw-text-opacity: 1;\n color: rgb(107 114 128 / var(--tw-text-opacity, 1))\n}\n.mint-text-gray-600 {\n --tw-text-opacity: 1;\n color: rgb(75 85 99 / var(--tw-text-opacity, 1))\n}\n.mint-text-gray-900 {\n --tw-text-opacity: 1;\n color: rgb(17 24 39 / var(--tw-text-opacity, 1))\n}\n.mint-underline {\n text-decoration-line: underline\n}\n.mint-underline-offset-2 {\n text-underline-offset: 2px\n}\n.dark\\:mint-border-white\\/10:is(.dark *) {\n border-color: rgb(255 255 255 / 0.1)\n}\n.dark\\:mint-bg-white\\/5:is(.dark *) {\n background-color: rgb(255 255 255 / 0.05)\n}\n.dark\\:mint-text-gray-100:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(243 244 246 / var(--tw-text-opacity, 1))\n}\n.dark\\:mint-text-gray-400:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(156 163 175 / var(--tw-text-opacity, 1))\n}","openApiReferenceData":{"operation":{"operationId":"createConversationNote","summary":"Add an internal note to a conversation","description":"Add an internal note to a conversation. The note is always private: the customer never sees it and it is never sent through the channel. Its author is the user the token belongs to — nothing in the body can choose another author or make the note public. Plain text only, no attachments; replying to the customer is not part of this endpoint.\n\nNotes can be added to a resolved conversation and do not reopen it. Mention links written in the text notify the agents they point to, as in the dashboard. The response has the same shape [List conversation messages](/api-reference/cloudchat/endpoints/list-conversation-messages) returns, with `private: true`. Visibility follows the same rule as the list: an administrator token reaches every inbox of the account, an agent token only its own inbox memberships. A conversation outside that reach answers 404, indistinguishable from an id that does not exist. A conversation merged into another one, or mirrored from another helpdesk, is read-only and answers 409.","tags":["Conversations"],"requestBody":"dd26db35-9574-4c65-bdec-e9eea6a6ad9f","responses":{"201":"6f99dd52-c1a2-46fa-83c4-9002e556afaf","400":"c954035a-6f68-4b71-929d-8de45920f0ab","401":"dedd81de-2785-4990-a8a3-6cb9ec122370","403":"dfd528d9-c72f-47fc-ac99-42b40929ebf4","404":"5bf12f52-8236-472a-be52-bc22532953b4","409":"398a23f7-9042-4662-a278-926873243f0f","422":"f8df169e-603a-47b5-a679-fdcb52151b65","429":"bca86463-e0da-46d4-bacf-d5ab5ff425ee","500":"b4137e66-9172-4130-be27-7d77cc183b64"},"method":"post","type":"path","servers":["637d0dd3-371a-440d-839a-2f45e44ca8d7"],"security":["4e01eef1-bc6b-4f11-84c7-1ecf76588784"],"path":"/v1/accounts/{accountId}/conversations/{conversationId}/notes","baseUrlOptions":["https://api.cloudhumans.com/cloudchat"],"title":"Add an internal note to a conversation","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"640cb33d-f63e-4231-92bd-2474c6231431":{"name":"cloudchat-instance","in":"header","required":true,"description":"Your Cloud Chat instance ID — an integer, fixed for your company, told at onboarding. [The API overview](/api-reference/cloudchat/overview#two-headers-every-call) explains how instances work, how to find yours, and the errors a wrong or missing value produces.","schema":{"type":"integer","example":1,"isRequired":true,"description":"Your Cloud Chat instance ID — an integer, fixed for your company, told at onboarding. [The API overview](/api-reference/cloudchat/overview#two-headers-every-call) explains how instances work, how to find yours, and the errors a wrong or missing value produces.","uniqueKey":"","typeLabel":"integer"}},"fb811442-7757-4ccc-89b8-d672b54a9baa":{"name":"accountId","in":"path","required":true,"description":"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.","schema":{"type":"integer","example":1,"isRequired":true,"description":"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.","uniqueKey":"","typeLabel":"integer"}},"a49cdba6-7a2a-45ed-8d35-270e6e66bfbb":{"name":"conversationId","in":"path","required":true,"description":"The conversation's **display_id** — the number shown in the dashboard URL and delivered in webhooks. It is never the internal database id.","schema":{"type":"integer","example":1042,"isRequired":true,"description":"The conversation's **display_id** — the number shown in the dashboard URL and delivered in webhooks. It is never the internal database id.","uniqueKey":"","typeLabel":"integer"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"The internal note to add.","required":["content"],"properties":{"content":{"type":"string","description":"The note text, plain text. It is stored as a private note: the customer never sees it. Blank text is a 422.","example":"Customer asked to be called back after 3 pm.","isRequired":true,"uniqueKey":"content","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"content":"Customer asked to be called back after 3 pm."},"examples":{"Example":{"title":"Example","value":{"content":"Customer asked to be called back after 3 pm."}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"6f99dd52-c1a2-46fa-83c4-9002e556afaf":{"description":"The note as stored.","content":{"application/json":{"schema":{"type":"object","description":"A single message of a conversation. Attachments and `content_attributes` are **not** exposed in this version — only the fields listed below.","required":["id","uuid","content","message_type","content_type","private","status","sender","created_at"],"properties":{"id":{"type":"integer","description":"Stable identifier, unique within the instance.","example":58211,"isRequired":true,"uniqueKey":"id","typeLabel":"integer"},"uuid":{"oneOf":[{"type":"string","description":"The message's canonical id, globally unique. For ClaudIA's reply and for the customer message that started the turn, it is the `messageId` the ClaudIA API takes in [Get a message trace](/api-reference/claudia/endpoints/get-message-trace), where the numeric `id` above does not resolve. `null` on older messages stored without one.","example":"8b0e5f3a-6c2d-4e71-9f4a-2d1c7b9e0a53","isRequired":true,"uniqueKey":"uuid.oneOf.0","typeLabel":"string"},{"type":"null","description":"The message's canonical id, globally unique. For ClaudIA's reply and for the customer message that started the turn, it is the `messageId` the ClaudIA API takes in [Get a message trace](/api-reference/claudia/endpoints/get-message-trace), where the numeric `id` above does not resolve. `null` on older messages stored without one.","example":"8b0e5f3a-6c2d-4e71-9f4a-2d1c7b9e0a53","isRequired":true,"uniqueKey":"uuid.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"uuid","typeLabel":"string | null"},"content":{"oneOf":[{"type":"string","description":"The message text. `null` on some activity or attachment-only messages.","example":"Thanks, that solved it!","isRequired":true,"uniqueKey":"content.oneOf.0","typeLabel":"string"},{"type":"null","description":"The message text. `null` on some activity or attachment-only messages.","example":"Thanks, that solved it!","isRequired":true,"uniqueKey":"content.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content","typeLabel":"string | null"},"message_type":{"type":"string","enum":["incoming","outgoing","activity","template"],"description":"Who originated it and how — `incoming` from the contact, `outgoing` from an agent or bot, `activity` a system event (status/assignment change), `template` an outbound message template (WhatsApp, etc).","example":"outgoing","isRequired":true,"uniqueKey":"message_type","typeLabel":"enum\u003cstring>"},"content_type":{"type":"string","description":"How the dashboard renders the message body. `text` covers the overwhelming majority of messages; the rest are the interactive/bot content types (`input_select`, `cards`, `form`, `article`, `input_csat`, and similar).","example":"text","enum":["text","input_text","input_textarea","input_email","input_select","cards","form","article","incoming_email","input_csat","integrations","sticker","follow_up","closing_message"],"isRequired":true,"uniqueKey":"content_type","typeLabel":"enum\u003cstring>"},"private":{"type":"boolean","description":"`true` for a private note — visible only to agents, never sent to the contact. This endpoint returns private notes like any other message; filter them out client-side if you don't want them.","example":false,"isRequired":true,"uniqueKey":"private","typeLabel":"boolean"},"status":{"oneOf":[{"type":"string","enum":["sent","delivered","read","failed"],"description":"Delivery status on the channel. `null` on message types that don't track delivery (e.g. `activity`).","example":"delivered","isRequired":true,"uniqueKey":"status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["sent","delivered","read","failed"],"description":"Delivery status on the channel. `null` on message types that don't track delivery (e.g. `activity`).","example":"delivered","isRequired":true,"uniqueKey":"status.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring> | null"},"sender":{"oneOf":[{"type":"object","description":"Who sent the message. `null` on an `activity` message (status changes, assignment changes, and the like), which has no author.\n\nA hidden admin — the platform's own support user, occasionally the sender of a system message — reports `type: \"user\"` with `id: null` and a masked `name`, indistinguishable from any other masking. There is no way to resolve a hidden admin's real id through this API.","required":["type","id","name"],"properties":{"type":{"type":"string","enum":["contact","user","agent_bot"],"description":"`user` covers both agents and administrators.","example":"user","isRequired":true,"uniqueKey":"sender.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"oneOf":[{"type":"integer","description":"The sender's id — contact id, user id or agent bot id depending on `type`. `null` when the sender is a hidden admin.","example":7,"isRequired":true,"uniqueKey":"sender.oneOf.0.id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The sender's id — contact id, user id or agent bot id depending on `type`. `null` when the sender is a hidden admin.","example":7,"isRequired":true,"uniqueKey":"sender.oneOf.0.id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sender.oneOf.0.id","typeLabel":"integer | null"},"name":{"type":"string","description":"Display name. Masked (a generic label, not the real name) when the sender is a hidden admin.","example":"Jane","isRequired":true,"uniqueKey":"sender.oneOf.0.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"sender.oneOf.0","typeLabel":"object"},{"type":"null","description":"Who sent the message. `null` on an `activity` message (status changes, assignment changes, and the like), which has no author.\n\nA hidden admin — the platform's own support user, occasionally the sender of a system message — reports `type: \"user\"` with `id: null` and a masked `name`, indistinguishable from any other masking. There is no way to resolve a hidden admin's real id through this API.","required":["type","id","name"],"properties":{"type":{"type":"string","enum":["contact","user","agent_bot"],"description":"`user` covers both agents and administrators.","example":"user"},"id":{"oneOf":[{"type":"integer","description":"The sender's id — contact id, user id or agent bot id depending on `type`. `null` when the sender is a hidden admin.","example":7},{"type":"null","description":"The sender's id — contact id, user id or agent bot id depending on `type`. `null` when the sender is a hidden admin.","example":7}]},"name":{"type":"string","description":"Display name. Masked (a generic label, not the real name) when the sender is a hidden admin.","example":"Jane"}},"isRequired":true,"uniqueKey":"sender.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sender","typeLabel":"object | null"},"created_at":{"type":"string","format":"date-time","description":"When it was created. ISO 8601, always UTC, milliseconds included.","example":"2026-08-13T19:09:51.482Z","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":58211,"uuid":"8b0e5f3a-6c2d-4e71-9f4a-2d1c7b9e0a53","content":"Thanks, that solved it!","message_type":"outgoing","content_type":"text","private":false,"status":"delivered","sender":{"type":"user","id":7,"name":"Jane"},"created_at":"2026-08-13T19:09:51.482Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"c954035a-6f68-4b71-929d-8de45920f0ab":{"description":"Malformed request: `content` sent as an array or a nested object instead of a plain value. `details` names the field.","content":{"application/json":{"schema":{"type":"object","description":"A `validation_failed` error, which carries `details`.","required":["error"],"properties":{"error":{"type":"object","required":["code","message","details"],"properties":{"code":{"type":"string","enum":["validation_failed"],"example":"validation_failed","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Localized to the account's language, like every other envelope message.","example":"The request payload is invalid.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","description":"One entry per rejected field. Unlike the envelope message above, the texts come from the model layer and are in English in practice (the model layer ships no translations) — match on code and field, never on the text.","items":{"type":"object","required":["field","code","message"],"properties":{"field":{"type":"string","description":"Which request field the rule was about — `short_code` or `content`. A rule that is not tied to either is reported as `base`, so treat `base` as \"the payload as a whole\" rather than a field you can highlight.","enum":["short_code","content","base"],"example":"short_code","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Which rule it broke — `blank` for a missing or empty value, `taken` for a `short_code` already used on the account.","example":"taken","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","example":"has already been taken","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"bad_request","message":"The request is malformed.","details":[{"field":"content","code":"invalid","message":"The value must be a single scalar, not an array or object."}]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"bad_request","message":"The request is malformed.","details":[{"field":"content","code":"invalid","message":"The value must be a single scalar, not an array or object."}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"dedd81de-2785-4990-a8a3-6cb9ec122370":{"description":"No Bearer token, or one that is expired, malformed, or not a Cognito token. Sign in again for a fresh `id_token`.","content":{"application/json":{"schema":{"type":"object","description":"The error envelope every Cloud Chat API response uses.","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"The stable, machine-readable reason. Branch on this, never on `message`.","enum":["unauthorized","forbidden","not_found","validation_failed","conflict","bad_request","internal_error","rate_limited","service_unavailable"],"example":"not_found","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"The reason in words, localized to your account's language (English, Spanish or Brazilian Portuguese; English when the account is set to anything else). Wording changes with the account and between releases, so never match on it.\n\nTwo cases stay in English whatever the account is set to: `unauthorized`, decided before any account is known, and the account-level `not_found`, which must not reveal the account's language.","example":"Resource could not be found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","description":"Present on some rejections — a 400 for a refused query parameter or upload mode, for example. One entry per offending field, localized to the account's language like `message` — match on `code` and `field`, never on the text.","items":{"type":"object","required":["field","code","message"],"properties":{"field":{"type":"string","description":"Which request field the rule was about.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","description":"Stable, machine-readable reason.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"The rule in words.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"unauthorized","message":"Authentication is required. Send a valid Bearer token in the Authorization header."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unauthorized","message":"Authentication is required. Send a valid Bearer token in the Authorization header."}}}},"exampleType":"examples"}},"exampleType":"examples"},"dfd528d9-c72f-47fc-ac99-42b40929ebf4":{"description":"The operation was refused for who you are, not for what you sent. Two causes:\n\n- **Your role does not permit it.** Several operations here need an administrator, and a few need a supervisor or a CX engineer; where it matters, the operation says so in its own 403. Changing your own role is not something the API can do — ask an administrator of the account.\n- **The account is suspended.** Then nothing on it can be read or written until that is resolved — talk to your Cloud Humans contact.\n\nNot being a member of the account is a **404**, not a 403: an account you cannot reach and an account that does not exist are deliberately indistinguishable.","content":{"application/json":{"schema":{"type":"object","description":"The error envelope every Cloud Chat API response uses.","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"The stable, machine-readable reason. Branch on this, never on `message`.","enum":["unauthorized","forbidden","not_found","validation_failed","conflict","bad_request","internal_error","rate_limited","service_unavailable"],"example":"not_found","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"The reason in words, localized to your account's language (English, Spanish or Brazilian Portuguese; English when the account is set to anything else). Wording changes with the account and between releases, so never match on it.\n\nTwo cases stay in English whatever the account is set to: `unauthorized`, decided before any account is known, and the account-level `not_found`, which must not reveal the account's language.","example":"Resource could not be found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","description":"Present on some rejections — a 400 for a refused query parameter or upload mode, for example. One entry per offending field, localized to the account's language like `message` — match on `code` and `field`, never on the text.","items":{"type":"object","required":["field","code","message"],"properties":{"field":{"type":"string","description":"Which request field the rule was about.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","description":"Stable, machine-readable reason.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"The rule in words.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"forbidden","message":"This account is suspended."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"forbidden","message":"This account is suspended."}}}},"exampleType":"examples"}},"exampleType":"examples"},"5bf12f52-8236-472a-be52-bc22532953b4":{"description":"The resource is not there for you. Three situations answer with this code, and the first two apply to **every** endpoint — the account is resolved before anything else runs, so a list or a create fails this way too:\n\n- the account does not exist on this instance,\n- the account exists but your token has no membership on it,\n- on an endpoint that names one, the resource it names (a canned response, a portal, an article) does not exist where the path says it does.\n\nThe first two are deliberately indistinguishable — same status, same body, and the message stays in English in both, since translating it would reveal the account's configured language. So you cannot use this endpoint to find out which account ids exist. The third case is localized like every other error, which is safe because you only reach it once membership is established.\n\nEither way a 404 is not worth retrying. Check the `accountId`, the `cloudchat-instance` value, and that your user is a member of the account.","content":{"application/json":{"schema":{"type":"object","description":"The error envelope every Cloud Chat API response uses.","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"The stable, machine-readable reason. Branch on this, never on `message`.","enum":["unauthorized","forbidden","not_found","validation_failed","conflict","bad_request","internal_error","rate_limited","service_unavailable"],"example":"not_found","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"The reason in words, localized to your account's language (English, Spanish or Brazilian Portuguese; English when the account is set to anything else). Wording changes with the account and between releases, so never match on it.\n\nTwo cases stay in English whatever the account is set to: `unauthorized`, decided before any account is known, and the account-level `not_found`, which must not reveal the account's language.","example":"Resource could not be found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","description":"Present on some rejections — a 400 for a refused query parameter or upload mode, for example. One entry per offending field, localized to the account's language like `message` — match on `code` and `field`, never on the text.","items":{"type":"object","required":["field","code","message"],"properties":{"field":{"type":"string","description":"Which request field the rule was about.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","description":"Stable, machine-readable reason.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"The rule in words.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"not_found","message":"Resource could not be found."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"not_found","message":"Resource could not be found."}}}},"exampleType":"examples"}},"exampleType":"examples"},"398a23f7-9042-4662-a278-926873243f0f":{"description":"The conversation was merged into another one, or is mirrored from another helpdesk, and is read-only. `error.details[0].code` says which: `merged` or `external_read_only`.","content":{"application/json":{"schema":{"type":"object","description":"A `validation_failed` error, which carries `details`.","required":["error"],"properties":{"error":{"type":"object","required":["code","message","details"],"properties":{"code":{"type":"string","enum":["validation_failed"],"example":"validation_failed","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Localized to the account's language, like every other envelope message.","example":"The request payload is invalid.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","description":"One entry per rejected field. Unlike the envelope message above, the texts come from the model layer and are in English in practice (the model layer ships no translations) — match on code and field, never on the text.","items":{"type":"object","required":["field","code","message"],"properties":{"field":{"type":"string","description":"Which request field the rule was about — `short_code` or `content`. A rule that is not tied to either is reported as `base`, so treat `base` as \"the payload as a whole\" rather than a field you can highlight.","enum":["short_code","content","base"],"example":"short_code","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Which rule it broke — `blank` for a missing or empty value, `taken` for a `short_code` already used on the account.","example":"taken","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","example":"has already been taken","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"conflict","message":"The request conflicts with the current state of the resource.","details":[{"field":"conversation","code":"merged","message":"This conversation was merged into another one and is read-only. Work on the conversation it was merged into."}]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"conflict","message":"The request conflicts with the current state of the resource.","details":[{"field":"conversation","code":"merged","message":"This conversation was merged into another one and is read-only. Work on the conversation it was merged into."}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"f8df169e-603a-47b5-a679-fdcb52151b65":{"description":"The note was refused. `details` names the field at fault: a `content` that is missing, blank or too long.","content":{"application/json":{"schema":{"type":"object","description":"A `validation_failed` error, which carries `details`.","required":["error"],"properties":{"error":{"type":"object","required":["code","message","details"],"properties":{"code":{"type":"string","enum":["validation_failed"],"example":"validation_failed","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Localized to the account's language, like every other envelope message.","example":"The request payload is invalid.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","description":"One entry per rejected field. Unlike the envelope message above, the texts come from the model layer and are in English in practice (the model layer ships no translations) — match on code and field, never on the text.","items":{"type":"object","required":["field","code","message"],"properties":{"field":{"type":"string","description":"Which request field the rule was about — `short_code` or `content`. A rule that is not tied to either is reported as `base`, so treat `base` as \"the payload as a whole\" rather than a field you can highlight.","enum":["short_code","content","base"],"example":"short_code","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Which rule it broke — `blank` for a missing or empty value, `taken` for a `short_code` already used on the account.","example":"taken","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","example":"has already been taken","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"validation_failed","message":"The request payload is invalid.","details":[{"field":"content","code":"blank","message":"Provide the note text in content. It cannot be blank."}]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"validation_failed","message":"The request payload is invalid.","details":[{"field":"content","code":"blank","message":"Provide the note text in content. It cannot be blank."}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"bca86463-e0da-46d4-bacf-d5ab5ff425ee":{"description":"Rate limited per credential. Note the envelope: this one is `{ \"message\": ... }`, because the request never reached the API.\n\nDon't hardcode the limit — read it from the response. `Retry-After` says how many seconds to wait, and every response (not just this one) carries `ratelimit-limit`, `ratelimit-remaining` and `ratelimit-reset`, the last in seconds.","content":{"application/json":{"schema":{"type":"object","description":"Rejected by the gateway before Cloud Chat saw it, so it does not use the `error` envelope.","required":["message"],"properties":{"message":{"type":"string","example":"API rate limit exceeded","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"request_id":{"type":"string","description":"Gateway request id. Quote it when reporting a problem.","example":"f3f7567638d4b65a8003057d0c77d275","uniqueKey":"request_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"API rate limit exceeded"},"examples":{"Example":{"title":"Example","value":{"message":"API rate limit exceeded"}}},"exampleType":"examples"}},"exampleType":"examples"},"b4137e66-9172-4130-be27-7d77cc183b64":{"description":"Something failed on our side. The response never carries the underlying error, but it is reported to our monitoring automatically — no need to file anything for a one-off.\n\nRetrying is reasonable, with one caveat on `POST`: a 500 does not prove the write did not happen, so a retry can come back `422` with `short_code` already taken. That 422 means the first attempt succeeded — list the account and confirm before treating it as a failure.","content":{"application/json":{"schema":{"type":"object","description":"The error envelope every Cloud Chat API response uses.","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"The stable, machine-readable reason. Branch on this, never on `message`.","enum":["unauthorized","forbidden","not_found","validation_failed","conflict","bad_request","internal_error","rate_limited","service_unavailable"],"example":"not_found","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"The reason in words, localized to your account's language (English, Spanish or Brazilian Portuguese; English when the account is set to anything else). Wording changes with the account and between releases, so never match on it.\n\nTwo cases stay in English whatever the account is set to: `unauthorized`, decided before any account is known, and the account-level `not_found`, which must not reveal the account's language.","example":"Resource could not be found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","description":"Present on some rejections — a 400 for a refused query parameter or upload mode, for example. One entry per offending field, localized to the account's language like `message` — match on `code` and `field`, never on the text.","items":{"type":"object","required":["field","code","message"],"properties":{"field":{"type":"string","description":"Which request field the rule was about.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","description":"Stable, machine-readable reason.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"The rule in words.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"internal_error","message":"An unexpected error occurred. Please try again later."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"internal_error","message":"An unexpected error occurred. Please try again later."}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"4e01eef1-bc6b-4f11-84c7-1ecf76588784":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The `id_token` from `POST /auth/v1/signin`, sent as `Authorization: Bearer \u003cid_token>`. Not the `access_token` — that one does not carry the identity Cloud Chat authorizes on.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"637d0dd3-371a-440d-839a-2f45e44ca8d7":{"url":"https://api.cloudhumans.com/cloudchat","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The `id_token` from `POST /auth/v1/signin`, sent as `Authorization: Bearer \u003cid_token>`. Not the `access_token` — that one does not carry the identity Cloud Chat authorizes on.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"The `id_token` from `POST /auth/v1/signin`, sent as `Authorization: Bearer \u003cid_token>`. Not the `access_token` — that one does not carry the identity Cloud Chat authorizes on.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/specs/cloudchat/v1.json"},"subdomain":"cloud-humans","siteName":"Cloud Chat","title":"Add an internal note to a conversation - Cloud Chat","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-10T17:00:56.647Z","originalFileLocation":"api-reference/cloudchat/endpoints/add-a-conversation-note.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Add an internal note to a conversation. The note is always private: the customer never sees it and it is never sent through the channel. Its author is the user the token belongs to — nothing in the body can choose another author or make the note public. Plain text only, no attachments; replying to the customer is not part of this endpoint. Notes can be added to a resolved conversation and do not reopen it. Mention links written in the text notify the agents they point to, as in the dashboard. The response has the same shape List conversation messages returns, with private: true. Visibility follows the same rule as the list: an administrator token reaches every inbox of the account, an agent token only its own inbox memberships. A conversation outside that reach answers 404, indistinguishable from an id that does not exist. A conversation merged into another one, or mirrored from another helpdesk, is read-only and answers 409.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Cloud Chat\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cloud-humans/Tjh_1uQRibuZjdTW/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/cloud-humans/Tjh_1uQRibuZjdTW/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cloud-humans/Tjh_1uQRibuZjdTW/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cloud-humans/Tjh_1uQRibuZjdTW/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cloud-humans/Tjh_1uQRibuZjdTW/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cloud-humans/Tjh_1uQRibuZjdTW/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cloud-humans/Tjh_1uQRibuZjdTW/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cloud-humans/Tjh_1uQRibuZjdTW/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cloud-humans/Tjh_1uQRibuZjdTW/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Add an internal note to a conversation - Cloud Chat\">\u003cmeta data-mint-head property=\"og:description\" content=\"Add an internal note to a conversation. The note is always private: the customer never sees it and it is never sent through the channel. Its author is the user the token belongs to — nothing in the body can choose another author or make the note public. Plain text only, no attachments; replying to the customer is not part of this endpoint. Notes can be added to a resolved conversation and do not reopen it. Mention links written in the text notify the agents they point to, as in the dashboard. The response has the same shape List conversation messages returns, with private: true. Visibility follows the same rule as the list: an administrator token reaches every inbox of the account, an agent token only its own inbox memberships. A conversation outside that reach answers 404, indistinguishable from an id that does not exist. A conversation merged into another one, or mirrored from another helpdesk, is read-only and answers 409.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cloud Chat\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/add-a-conversation-note\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cloud-humans.mintlify.site/_mintlify/api/og/v2?division=Conversations\u0026amp;title=Add+an+internal+note+to+a+conversation\u0026amp;description=Add+an+internal+note+to+a+conversation.+The+note+is+always+private%3A+the+customer+never+sees+it+and+it+is+never+sent+through+the+channel.+Its+author+is+the+user+\u0026amp;theme=f1ab87c694400f10daae88f8\u0026amp;signature=a12ad387322c60847454a0df33e7850d7e782dc2d4f679ade82ecd82d45e413d\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Add an internal note to a conversation - Cloud Chat\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Add an internal note to a conversation. The note is always private: the customer never sees it and it is never sent through the channel. Its author is the user the token belongs to — nothing in the body can choose another author or make the note public. Plain text only, no attachments; replying to the customer is not part of this endpoint. Notes can be added to a resolved conversation and do not reopen it. Mention links written in the text notify the agents they point to, as in the dashboard. The response has the same shape List conversation messages returns, with private: true. Visibility follows the same rule as the list: an administrator token reaches every inbox of the account, an agent token only its own inbox memberships. A conversation outside that reach answers 404, indistinguishable from an id that does not exist. A conversation merged into another one, or mirrored from another helpdesk, is read-only and answers 409.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cloud-humans.mintlify.site/_mintlify/api/og/v2?division=Conversations\u0026amp;title=Add+an+internal+note+to+a+conversation\u0026amp;description=Add+an+internal+note+to+a+conversation.+The+note+is+always+private%3A+the+customer+never+sees+it+and+it+is+never+sent+through+the+channel.+Its+author+is+the+user+\u0026amp;theme=f1ab87c694400f10daae88f8\u0026amp;signature=a12ad387322c60847454a0df33e7850d7e782dc2d4f679ade82ecd82d45e413d\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/cloud-humans/Tjh_1uQRibuZjdTW/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cloud Chat\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#EF7221\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/add-a-conversation-note\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/cloudchat/endpoints/add-a-conversation-note.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cloudhumans.com/#organization\",\"name\":\"Cloud Chat\",\"url\":\"https://docs.cloudhumans.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cloud-humans/GHbxWTY81Qa4762I/logo/light.svg?fit=max\u0026auto=format\u0026n=GHbxWTY81Qa4762I\u0026q=85\u0026s=2899d32cd5c5f8adff5bb4390125f626\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cloudhumans.com#website\",\"name\":\"Cloud Chat\",\"url\":\"https://docs.cloudhumans.com\",\"publisher\":{\"@id\":\"https://docs.cloudhumans.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/add-a-conversation-note#webpage\",\"url\":\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/add-a-conversation-note\",\"name\":\"Add an internal note to a conversation\",\"description\":\"Add an internal note to a conversation. The note is always private: the customer never sees it and it is never sent through the channel. Its author is the user the token belongs to — nothing in the body can choose another author or make the note public. Plain text only, no attachments; replying to the customer is not part of this endpoint. Notes can be added to a resolved conversation and do not reopen it. Mention links written in the text notify the agents they point to, as in the dashboard. The response has the same shape List conversation messages returns, with private: true. Visibility follows the same rule as the list: an administrator token reaches every inbox of the account, an agent token only its own inbox memberships. A conversation outside that reach answers 404, indistinguishable from an id that does not exist. A conversation merged into another one, or mirrored from another helpdesk, is read-only and answers 409.\",\"dateModified\":\"2026-11-10T17:00:56.647Z\",\"isPartOf\":{\"@id\":\"https://docs.cloudhumans.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/add-a-conversation-note#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/add-a-conversation-note#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Conversations\",\"item\":\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/list-conversations\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Add an internal note to a conversation\",\"item\":\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/add-a-conversation-note\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/add-a-conversation-note#apireference\",\"headline\":\"Add an internal note to a conversation\",\"name\":\"Add an internal note to a conversation\",\"description\":\"Add an internal note to a conversation. The note is always private: the customer never sees it and it is never sent through the channel. Its author is the user the token belongs to — nothing in the body can choose another author or make the note public. Plain text only, no attachments; replying to the customer is not part of this endpoint. Notes can be added to a resolved conversation and do not reopen it. Mention links written in the text notify the agents they point to, as in the dashboard. The response has the same shape List conversation messages returns, with private: true. Visibility follows the same rule as the list: an administrator token reaches every inbox of the account, an agent token only its own inbox memberships. A conversation outside that reach answers 404, indistinguishable from an id that does not exist. A conversation merged into another one, or mirrored from another helpdesk, is read-only and answers 409.\",\"url\":\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/add-a-conversation-note\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/add-a-conversation-note#webpage\"},\"dateModified\":\"2026-11-10T17:00:56.647Z\",\"publisher\":{\"@id\":\"https://docs.cloudhumans.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cloudhumans.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cloud Chat\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Cloud Chat\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/cloudchat/endpoints/add-a-conversation-note.md","siteName":"Cloud Chat","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","products":[{"product":"Cloud Chat","icon":"messages","groups":[{"group":"Getting Started","pages":[{"title":"Cloud Chat API","href":"/api-reference/cloudchat/overview"},{"title":"Find your credentials","href":"/api-reference/cloudchat/credentials"}]},{"group":"Authentication","pages":[{"title":"Sign in and get a token","deprecated":null,"version":null,"openapi":"/api-reference/specs/auth/v1.json post /v1/signin","href":"/api-reference/cloudchat/v1/auth/authentication/sign-in-and-get-a-token"},{"title":"Answer a sign-in challenge","deprecated":null,"version":null,"openapi":"/api-reference/specs/auth/v1.json post /v1/signin/challenge","href":"/api-reference/cloudchat/v1/auth/authentication/answer-a-sign-in-challenge"}]},{"group":"Canned Responses","pages":[{"title":"List canned responses","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/canned-responses","href":"/api-reference/cloudchat/endpoints/list-canned-responses"},{"title":"Get a canned response","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/canned-responses/{cannedResponseId}","href":"/api-reference/cloudchat/endpoints/get-a-canned-response"},{"title":"Create a canned response","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/canned-responses","href":"/api-reference/cloudchat/endpoints/create-a-canned-response"},{"title":"Update a canned response","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/canned-responses/{cannedResponseId}","href":"/api-reference/cloudchat/endpoints/update-a-canned-response"},{"title":"Delete a canned response","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/canned-responses/{cannedResponseId}","href":"/api-reference/cloudchat/endpoints/delete-a-canned-response"}]},{"group":"Conversations","pages":[{"title":"List conversations","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/conversations","href":"/api-reference/cloudchat/endpoints/list-conversations"},{"title":"Find a conversation by any identifier","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/conversations/find","href":"/api-reference/cloudchat/endpoints/find-a-conversation"},{"title":"Get a conversation","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/conversations/{conversationId}","href":"/api-reference/cloudchat/endpoints/get-a-conversation"},{"title":"List conversation messages","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/conversations/{conversationId}/messages","href":"/api-reference/cloudchat/endpoints/list-conversation-messages"},{"title":"List CSAT answers","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/csat-responses","href":"/api-reference/cloudchat/endpoints/list-csat-answers"},{"title":"Open a conversation","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/conversations","href":"/api-reference/cloudchat/endpoints/open-a-conversation"},{"title":"Update a conversation","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/conversations/{conversationId}","href":"/api-reference/cloudchat/endpoints/update-a-conversation"},{"title":"Change the status of a conversation","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/conversations/{conversationId}/status","href":"/api-reference/cloudchat/endpoints/change-conversation-status"},{"title":"Assign a conversation","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/conversations/{conversationId}/assignments","description":"This is the endpoint for taking a conversation away from ClaudIA and handing it to a person, yourself included: assign the conversation to a human agent while ClaudIA holds it and ClaudIA is told to step aside. To take it yourself, send your own agent id as `assignee_id`; find it with [List agents](/api-reference/cloudchat/endpoints/list-agents) by searching for your own e-mail. It also assigns a conversation to an agent, to a team, or to both. The targets go under an `assignment` wrapper: `assignee_id` (an id from [List agents](/api-reference/cloudchat/endpoints/list-agents)) and `team_id` (an id from [List teams](/api-reference/cloudchat/endpoints/list-teams)). Send `null` for one of them to remove the current agent or team, and leave the key out to keep it as it is. At least one of the two is required.\n\nIds must belong to this account: an id that is not an active agent of the account, or a team of another account, is a 422 and the message says which list to read again. ClaudIA agents cannot be assigned through this endpoint; hand a conversation back to ClaudIA from the Cloud Chat screen.\n\nThat takeover — assigning a person, or a team that does not include ClaudIA, while ClaudIA holds the conversation — follows the account's takeover permissions. A role that may not take over gets a 403 and nothing changes. When ClaudIA cannot be reached the answer is 503 and the conversation stays as it was.\n\nWhen both keys are sent the team is applied first, so a failure on the agent leaves the team already changed. Visibility follows the same rule as the list: an administrator token reaches every inbox of the account, an agent token only its own inbox memberships. A conversation outside that reach answers 404, indistinguishable from an id that does not exist. A conversation mirrored from another helpdesk is read-only here and answers 409.","href":"/api-reference/cloudchat/endpoints/assign-a-conversation"},{"title":"Add an internal note to a conversation","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/conversations/{conversationId}/notes","href":"/api-reference/cloudchat/endpoints/add-a-conversation-note"},{"title":"Block the contact of a conversation","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/conversations/{conversationId}/mute","description":"Block the customer of a conversation on the inbox it lives in — the **Block contact** button of the dashboard.\n\nWhat happens:\n\n- The conversation is **resolved** right away, with the same events as any resolution. As with the dashboard, resolving can make Cloud Chat send the customer the satisfaction survey when the inbox has it enabled, and that message cannot be taken back.\n- The customer is marked as **blocked on that inbox**. The block covers every conversation they have there and none they have on another inbox.\n- While it lasts, the customer's messages are still received and kept, but they no longer reopen a conversation. On every inbox type except the website widget, a new conversation the customer starts is created already resolved, so nothing reaches the team's queue. On a website widget inbox a new conversation still opens normally, and the customer stops receiving the email copy of agent replies.\n- It is a Cloud Chat setting only: the customer is not told, and nothing is blocked at the channel provider (WhatsApp, Instagram and so on). An activity line in the conversation records who blocked the contact.\n\nBlocking is idempotent: when the customer is already blocked on the inbox, the call answers 200 with the current state and changes nothing. Lift the block with [Unblock the contact of a conversation](/api-reference/cloudchat/endpoints/unblock-the-contact-of-a-conversation).\n\nWhich roles may block is chosen per account by its administrators in the account setting **Roles allowed to block contacts**. By default every role except Assistant can; a role without the permission gets a 403 and nothing changes. A customer whose email already bounced on the inbox is already blocked by the system and answers 409, and so does a conversation mirrored from another helpdesk, which is read-only here.\n\nThe response reads the state back after the write: `muted`, the conversation `status`, and the `contact` and `inbox` the block applies to. Visibility follows the same rule as the list: an administrator token reaches every inbox of the account, an agent token only its own inbox memberships. A conversation outside that reach answers 404, indistinguishable from an id that does not exist.","href":"/api-reference/cloudchat/endpoints/block-the-contact-of-a-conversation"},{"title":"Unblock the contact of a conversation","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/conversations/{conversationId}/unmute","href":"/api-reference/cloudchat/endpoints/unblock-the-contact-of-a-conversation"}]},{"group":"Contacts","pages":[{"title":"List contacts","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/contacts","href":"/api-reference/cloudchat/endpoints/list-contacts"},{"title":"Search contacts","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/contacts/search","href":"/api-reference/cloudchat/endpoints/search-contacts"},{"title":"Get a contact","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/contacts/{contactId}","href":"/api-reference/cloudchat/endpoints/get-a-contact"},{"title":"Create a contact","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/contacts","href":"/api-reference/cloudchat/endpoints/create-a-contact"},{"title":"Update a contact","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/contacts/{contactId}","href":"/api-reference/cloudchat/endpoints/update-a-contact"}]},{"group":"Companies","pages":[{"title":"List companies","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/companies","href":"/api-reference/cloudchat/endpoints/list-companies"},{"title":"Get a company","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/companies/{companyId}","href":"/api-reference/cloudchat/endpoints/get-a-company"},{"title":"Update a company","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/companies/{companyId}","href":"/api-reference/cloudchat/endpoints/update-a-company"},{"title":"List a contact's companies","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/contacts/{contactId}/companies","href":"/api-reference/cloudchat/endpoints/list-contact-companies"},{"title":"Link a contact to a company","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/contacts/{contactId}/companies","href":"/api-reference/cloudchat/endpoints/link-a-contact-to-a-company"},{"title":"Unlink a contact from a company","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/contacts/{contactId}/companies/{companyId}","href":"/api-reference/cloudchat/endpoints/unlink-a-contact-from-a-company"}]},{"group":"Labels","pages":[{"title":"List labels","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/labels","href":"/api-reference/cloudchat/endpoints/list-labels"},{"title":"Get a label","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/labels/{labelId}","href":"/api-reference/cloudchat/endpoints/get-a-label"},{"title":"Create a label","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/labels","href":"/api-reference/cloudchat/endpoints/create-a-label"},{"title":"Update a label","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/labels/{labelId}","href":"/api-reference/cloudchat/endpoints/update-a-label"},{"title":"Add labels to a conversation","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/conversations/{conversationId}/labels","href":"/api-reference/cloudchat/endpoints/add-labels-to-a-conversation"},{"title":"Remove labels from a conversation","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/conversations/{conversationId}/labels","href":"/api-reference/cloudchat/endpoints/remove-labels-from-a-conversation"},{"title":"List the labels of a contact","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/contacts/{contactId}/labels","href":"/api-reference/cloudchat/endpoints/list-contact-labels"},{"title":"Add labels to a contact","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/contacts/{contactId}/labels","href":"/api-reference/cloudchat/endpoints/add-labels-to-a-contact"},{"title":"Remove labels from a contact","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/contacts/{contactId}/labels","href":"/api-reference/cloudchat/endpoints/remove-labels-from-a-contact"}]},{"group":"Inboxes","pages":[{"title":"List inboxes","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/inboxes","href":"/api-reference/cloudchat/endpoints/list-inboxes"},{"title":"Get an inbox","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/inboxes/{inboxId}","href":"/api-reference/cloudchat/endpoints/get-an-inbox"},{"title":"Update an inbox's settings","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/inboxes/{inboxId}","href":"/api-reference/cloudchat/endpoints/update-an-inbox"},{"title":"List inbox members","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/inboxes/{inboxId}/members","href":"/api-reference/cloudchat/endpoints/list-inbox-members"},{"title":"Add inbox members","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/inboxes/{inboxId}/members","href":"/api-reference/cloudchat/endpoints/add-inbox-members"},{"title":"Remove inbox members","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/inboxes/{inboxId}/members","href":"/api-reference/cloudchat/endpoints/remove-inbox-members"},{"title":"Get the satisfaction survey of an inbox","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/inboxes/{inboxId}/csat-survey","href":"/api-reference/cloudchat/endpoints/get-the-satisfaction-survey-of-an-inbox"},{"title":"Update the satisfaction survey of an inbox","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/inboxes/{inboxId}/csat-survey","href":"/api-reference/cloudchat/endpoints/update-the-satisfaction-survey-of-an-inbox"}]},{"group":"Campaigns","pages":[{"title":"Preview campaign recipients","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/campaigns/preview-recipients","href":"/api-reference/cloudchat/endpoints/preview-campaign-recipients"},{"title":"Create a campaign","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/campaigns","href":"/api-reference/cloudchat/endpoints/create-a-campaign"},{"title":"Get a campaign","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/campaigns/{campaignId}","href":"/api-reference/cloudchat/endpoints/get-a-campaign"},{"title":"List campaign variables","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/campaigns/variables","href":"/api-reference/cloudchat/endpoints/list-campaign-variables"},{"title":"List message templates","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/inboxes/{inboxId}/message-templates","href":"/api-reference/cloudchat/endpoints/list-message-templates"},{"title":"Create a message template","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/inboxes/{inboxId}/message-templates","href":"/api-reference/cloudchat/endpoints/create-a-message-template"},{"title":"Update a message template","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/inboxes/{inboxId}/message-templates/{name}","href":"/api-reference/cloudchat/endpoints/update-a-message-template"}]},{"group":"Reports","pages":[{"title":"List reports","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/reports","href":"/api-reference/cloudchat/endpoints/list-reports"},{"title":"Get a report","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/reports/{reportKey}","href":"/api-reference/cloudchat/endpoints/get-a-report"},{"title":"List report query fields","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/report-queries/fields","href":"/api-reference/cloudchat/endpoints/list-report-query-fields"},{"title":"Run a report query","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/report-queries","href":"/api-reference/cloudchat/endpoints/run-a-report-query"}]},{"group":"Agents","pages":[{"title":"List agents","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/agents","href":"/api-reference/cloudchat/endpoints/list-agents"},{"title":"Get an agent","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/agents/{agentId}","href":"/api-reference/cloudchat/endpoints/get-an-agent"},{"title":"Create an agent","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/agents","href":"/api-reference/cloudchat/endpoints/create-an-agent"},{"title":"Update an agent","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/agents/{agentId}","href":"/api-reference/cloudchat/endpoints/update-an-agent"},{"title":"Get agent access","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/agents/{agentId}/access","href":"/api-reference/cloudchat/endpoints/get-agent-access"},{"title":"Set agent access","openapi":"api-reference/specs/cloudchat/v1.json PUT /v1/accounts/{accountId}/agents/{agentId}/access","href":"/api-reference/cloudchat/endpoints/set-agent-access"}]},{"group":"Teams","pages":[{"title":"List teams","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/teams","href":"/api-reference/cloudchat/endpoints/list-teams"},{"title":"Get a team","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/teams/{teamId}","href":"/api-reference/cloudchat/endpoints/get-a-team"},{"title":"Create a team","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/teams","href":"/api-reference/cloudchat/endpoints/create-a-team"},{"title":"Update a team","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/teams/{teamId}","href":"/api-reference/cloudchat/endpoints/update-a-team"},{"title":"List team members","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/teams/{teamId}/members","href":"/api-reference/cloudchat/endpoints/list-team-members"},{"title":"Add team members","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/teams/{teamId}/members","href":"/api-reference/cloudchat/endpoints/add-team-members"},{"title":"Remove team members","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/teams/{teamId}/members","href":"/api-reference/cloudchat/endpoints/remove-team-members"}]},{"group":"Macros","pages":[{"title":"List macros","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/macros","href":"/api-reference/cloudchat/endpoints/list-macros"},{"title":"Get a macro","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/macros/{macroId}","href":"/api-reference/cloudchat/endpoints/get-a-macro"},{"title":"Create a macro","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/macros","href":"/api-reference/cloudchat/endpoints/create-a-macro"},{"title":"Update a macro","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/macros/{macroId}","href":"/api-reference/cloudchat/endpoints/update-a-macro"}]},{"group":"Custom Views","pages":[{"title":"List custom views","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/custom-views","href":"/api-reference/cloudchat/endpoints/list-custom-views"},{"title":"Get a custom view","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/custom-views/{customViewId}","href":"/api-reference/cloudchat/endpoints/get-a-custom-view"},{"title":"Create a custom view","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/custom-views","href":"/api-reference/cloudchat/endpoints/create-a-custom-view"},{"title":"Update a custom view","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/custom-views/{customViewId}","href":"/api-reference/cloudchat/endpoints/update-a-custom-view"},{"title":"Delete a custom view","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/custom-views/{customViewId}","href":"/api-reference/cloudchat/endpoints/delete-a-custom-view"}]},{"group":"Automation Rules","pages":[{"title":"List automation rules","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/automation-rules","href":"/api-reference/cloudchat/endpoints/list-automation-rules"},{"title":"Get an automation rule","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/automation-rules/{automationRuleId}","href":"/api-reference/cloudchat/endpoints/get-an-automation-rule"},{"title":"Propose an automation rule","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/automation-rules/propose-create","href":"/api-reference/cloudchat/endpoints/propose-an-automation-rule"},{"title":"Confirm an automation rule","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/automation-rules/confirm-create","href":"/api-reference/cloudchat/endpoints/confirm-an-automation-rule"},{"title":"Propose automation rule edits","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/automation-rules/{automationRuleId}/propose-edits","href":"/api-reference/cloudchat/endpoints/propose-automation-rule-edits"},{"title":"Confirm automation rule edits","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/automation-rules/{automationRuleId}/confirm-edits","href":"/api-reference/cloudchat/endpoints/confirm-automation-rule-edits"},{"title":"Propose a new rule order","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/automation-rules/propose-reorder","href":"/api-reference/cloudchat/endpoints/propose-a-new-rule-order"},{"title":"Confirm a new rule order","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/automation-rules/confirm-reorder","href":"/api-reference/cloudchat/endpoints/confirm-a-new-rule-order"}]},{"group":"Availability Reasons","pages":[{"title":"List availability reasons","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/availability-reasons","href":"/api-reference/cloudchat/endpoints/list-availability-reasons"},{"title":"Create an availability reason","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/availability-reasons","href":"/api-reference/cloudchat/endpoints/create-an-availability-reason"},{"title":"Update an availability reason","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/availability-reasons/{availabilityReasonId}","href":"/api-reference/cloudchat/endpoints/update-an-availability-reason"},{"title":"Delete an availability reason","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/availability-reasons/{availabilityReasonId}","href":"/api-reference/cloudchat/endpoints/delete-an-availability-reason"}]},{"group":"Native Attribute Requirements","pages":[{"title":"List native attribute requirements","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/native-attribute-requirements","href":"/api-reference/cloudchat/endpoints/list-native-attribute-requirements"},{"title":"Require a native attribute","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/native-attribute-requirements","href":"/api-reference/cloudchat/endpoints/create-a-native-attribute-requirement"},{"title":"Stop requiring a native attribute","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/native-attribute-requirements/{nativeAttributeRequirementId}","href":"/api-reference/cloudchat/endpoints/delete-a-native-attribute-requirement"}]},{"group":"Custom Attributes","pages":[{"title":"List custom attributes","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/custom-attributes","href":"/api-reference/cloudchat/endpoints/list-custom-attributes"},{"title":"Get a custom attribute","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/custom-attributes/{customAttributeId}","href":"/api-reference/cloudchat/endpoints/get-a-custom-attribute"},{"title":"Create a custom attribute","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/custom-attributes","href":"/api-reference/cloudchat/endpoints/create-a-custom-attribute"},{"title":"Update a custom attribute","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/custom-attributes/{customAttributeId}","href":"/api-reference/cloudchat/endpoints/update-a-custom-attribute"}]},{"group":"Help Center","pages":[{"title":"List portals","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/portals","href":"/api-reference/cloudchat/endpoints/list-portals"},{"title":"Get a portal","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/portals/{portalSlug}","href":"/api-reference/cloudchat/endpoints/get-a-portal"},{"title":"Create a portal","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/portals","href":"/api-reference/cloudchat/endpoints/create-a-portal"},{"title":"Update a portal","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/portals/{portalSlug}","href":"/api-reference/cloudchat/endpoints/update-a-portal"},{"title":"List categories","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/portals/{portalSlug}/categories","href":"/api-reference/cloudchat/endpoints/list-categories"},{"title":"Get a category","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/portals/{portalSlug}/categories/{categoryId}","href":"/api-reference/cloudchat/endpoints/get-a-category"},{"title":"Create a category","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/portals/{portalSlug}/categories","href":"/api-reference/cloudchat/endpoints/create-a-category"},{"title":"Update a category","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/portals/{portalSlug}/categories/{categoryId}","href":"/api-reference/cloudchat/endpoints/update-a-category"},{"title":"Delete a category","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/portals/{portalSlug}/categories/{categoryId}","href":"/api-reference/cloudchat/endpoints/delete-a-category"},{"title":"List articles","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/portals/{portalSlug}/articles","href":"/api-reference/cloudchat/endpoints/list-articles"},{"title":"Get an article","openapi":"api-reference/specs/cloudchat/v1.json GET /v1/accounts/{accountId}/portals/{portalSlug}/articles/{articleId}","href":"/api-reference/cloudchat/endpoints/get-an-article"},{"title":"Create an article","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/portals/{portalSlug}/articles","href":"/api-reference/cloudchat/endpoints/create-an-article"},{"title":"Update an article","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/portals/{portalSlug}/articles/{articleId}","href":"/api-reference/cloudchat/endpoints/update-an-article"},{"title":"Translate an article","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/portals/{portalSlug}/articles/{articleId}/translate","href":"/api-reference/cloudchat/endpoints/translate-an-article"},{"title":"Delete an article","openapi":"api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/portals/{portalSlug}/articles/{articleId}","href":"/api-reference/cloudchat/endpoints/delete-an-article"}]},{"group":"Uploads","pages":[{"title":"Upload an image","openapi":"api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/uploads","href":"/api-reference/cloudchat/endpoints/upload-an-image"}]}]},{"product":"Claudia","icon":"robot","pages":[{"title":"Claudia","href":"/api-reference/claudia/sign-in"}]},{"product":"Controlled Flows","icon":"diagram-project","pages":[{"title":"Controlled Flows","href":"/api-reference/controlled-flows/overview"}]}]}]},"basePath":"","title":"Add an internal note to a conversation - Cloud Chat","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js","Markdown-CwtoSfEf.js","AssistantPageLink-CTqa3eoi.js","dist-DIfYWxfm.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}