{
"error": {
"code": "bad_request",
"message": "The request is malformed.",
"details": [
{
"field": "company",
"code": "empty",
"message": "Provide at least one of name, description or custom_attributes inside company."
}
]
}
}
{
"error": {
"code": "unauthorized",
"message": "Authentication is required. Send a valid Bearer token in the Authorization header."
}
}
{
"error": {
"code": "forbidden",
"message": "You are not allowed to perform this action.",
"details": [
{
"field": "custom_attributes.cnpj",
"code": "forbidden",
"message": "You are not allowed to change this attribute."
}
]
}
}
{
"error": {
"code": "not_found",
"message": "Resource could not be found."
}
}
{
"error": {
"code": "validation_failed",
"message": "The request payload is invalid.",
"details": [
{
"field": "custom_attributes",
"code": "segmento is not a company custom attribute",
"message": "segmento is not a company custom attribute"
}
]
}
}
A partial update of name, description and custom_attributes. Fields you leave out keep their current value.
custom_attributes is merged, not replaced: send only the keys you want to change, and send a key as null to clear it. Changing a parent attribute can also clear the conditional attributes that depend on it, including ones hidden or read-only for your role; the response shows what remains of the attributes you can see. Each key must be a company attribute of the account and each value must fit its definition — a list attribute only accepts one of its options — or the call answers 422 and nothing is written.
domain and labels cannot be changed here, but sending them unchanged is accepted, so you can send back a company you read: a domain equal to the current one (compared after normalization, or null when the company has none), and labels equal to the current ones in any order. A real change of either answers 400 with error.details naming domain or labels (code not_editable), and nothing is saved. Unchanged domain and labels do not count as fields to update: a payload with none of name, description or custom_attributes answers 400 as empty.
An assistant cannot update companies. Other roles can, except for attributes that are read-only or hidden for their role: sending one of those answers 403 with error.details naming custom_attributes.<key>, and nothing is written.
{
"error": {
"code": "bad_request",
"message": "The request is malformed.",
"details": [
{
"field": "company",
"code": "empty",
"message": "Provide at least one of name, description or custom_attributes inside company."
}
]
}
}
{
"error": {
"code": "unauthorized",
"message": "Authentication is required. Send a valid Bearer token in the Authorization header."
}
}
{
"error": {
"code": "forbidden",
"message": "You are not allowed to perform this action.",
"details": [
{
"field": "custom_attributes.cnpj",
"code": "forbidden",
"message": "You are not allowed to change this attribute."
}
]
}
}
{
"error": {
"code": "not_found",
"message": "Resource could not be found."
}
}
{
"error": {
"code": "validation_failed",
"message": "The request payload is invalid.",
"details": [
{
"field": "custom_attributes",
"code": "segmento is not a company custom attribute",
"message": "segmento is not a company custom attribute"
}
]
}
}
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
companyId
integer
required
The id returned when the company was listed. A company of another account answers 404, the same as an id that does not exist.
Example:
314
Body
application/json
company
object
required
At least one of the three fields. Whatever you omit is left as it is. domain and labels are not editable here: sending them equal to the current values is accepted and ignored, while a different value answers 400 and nothing is saved.
Show child attributes
Response
Updated, with the values now stored.
A company of the account.
id
integer
required
The company id. Send it as companyId or company_id to the other company operations.
Example:
314
name
string
required
The company name.
Example:
"Transportadora Rápida"
domain
string | null
required
The company's web domain, null when it has none. Read-only through this API.
Example:
"rapida.com.br"
description
string | null
required
Free text about the company, null when it has none.
Example:
"Transportadora parceira para entregas no Sudeste."
contacts_count
integer
required
How many contacts are linked to the company.
Example:
3
labels
string[]
required
The labels on the company, by name. An empty array when it has none.
Example:
["transportadora"]
custom_attributes
object
required
The company's custom attributes, keyed by attribute key. A value is a string, a number, a boolean or an array of strings (for a multi-select list). An attribute your role cannot see is left out entirely, not returned as null, so a missing key can mean either "not set" or "not visible to you". An empty object when none are set.
When the company was created. ISO 8601 in UTC, with milliseconds.
Example:
"2026-08-14T12:30:05.412Z"
updated_at
string<date-time>
required
When the company was last changed, in the same format.
Example:
"2026-10-28T17:02:41.903Z"
{"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":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/cloudchat/endpoints/update-a-company","slug":"/api-reference/cloudchat/endpoints/update-a-company","pageMetadata":{"title":"Update a company","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/companies/{companyId}","description":"A partial update of `name`, `description` and `custom_attributes`. Fields you leave out keep their current value.\n\n`custom_attributes` is **merged**, not replaced: send only the keys you want to change, and send a key as `null` to clear it. Changing a parent attribute can also clear the conditional attributes that depend on it, including ones hidden or read-only for your role; the response shows what remains of the attributes you can see. Each key must be a company attribute of the account and each value must fit its definition — a list attribute only accepts one of its options — or the call answers `422` and nothing is written.\n\n`domain` and `labels` cannot be changed here, but sending them unchanged is accepted, so you can send back a company you read: a `domain` equal to the current one (compared after normalization, or `null` when the company has none), and `labels` equal to the current ones in any order. A real change of either answers `400` with `error.details` naming `domain` or `labels` (code `not_editable`), and nothing is saved. Unchanged `domain` and `labels` do not count as fields to update: a payload with none of `name`, `description` or `custom_attributes` answers `400` as empty.\n\nAn assistant cannot update companies. Other roles can, except for attributes that are read-only or hidden for their role: sending one of those answers `403` with `error.details` naming `custom_attributes.\u003ckey>`, and nothing is written.","href":"/api-reference/cloudchat/endpoints/update-a-company"},"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 code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"A partial update of \", _jsx(_components.code, {\n children: \"name\"\n }), \", \", _jsx(_components.code, {\n children: \"description\"\n }), \" and \", _jsx(_components.code, {\n children: \"custom_attributes\"\n }), \". Fields you leave out keep their current value.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"custom_attributes\"\n }), \" is \", _jsx(_components.strong, {\n children: \"merged\"\n }), \", not replaced: send only the keys you want to change, and send a key as \", _jsx(_components.code, {\n children: \"null\"\n }), \" to clear it. Changing a parent attribute can also clear the conditional attributes that depend on it, including ones hidden or read-only for your role; the response shows what remains of the attributes you can see. Each key must be a company attribute of the account and each value must fit its definition — a list attribute only accepts one of its options — or the call answers \", _jsx(_components.code, {\n children: \"422\"\n }), \" and nothing is written.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"domain\"\n }), \" and \", _jsx(_components.code, {\n children: \"labels\"\n }), \" cannot be changed here, but sending them unchanged is accepted, so you can send back a company you read: a \", _jsx(_components.code, {\n children: \"domain\"\n }), \" equal to the current one (compared after normalization, or \", _jsx(_components.code, {\n children: \"null\"\n }), \" when the company has none), and \", _jsx(_components.code, {\n children: \"labels\"\n }), \" equal to the current ones in any order. A real change of either answers \", _jsx(_components.code, {\n children: \"400\"\n }), \" with \", _jsx(_components.code, {\n children: \"error.details\"\n }), \" naming \", _jsx(_components.code, {\n children: \"domain\"\n }), \" or \", _jsx(_components.code, {\n children: \"labels\"\n }), \" (code \", _jsx(_components.code, {\n children: \"not_editable\"\n }), \"), and nothing is saved. Unchanged \", _jsx(_components.code, {\n children: \"domain\"\n }), \" and \", _jsx(_components.code, {\n children: \"labels\"\n }), \" do not count as fields to update: a payload with none of \", _jsx(_components.code, {\n children: \"name\"\n }), \", \", _jsx(_components.code, {\n children: \"description\"\n }), \" or \", _jsx(_components.code, {\n children: \"custom_attributes\"\n }), \" answers \", _jsx(_components.code, {\n children: \"400\"\n }), \" as empty.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"An assistant cannot update companies. Other roles can, except for attributes that are read-only or hidden for their role: sending one of those answers \", _jsx(_components.code, {\n children: \"403\"\n }), \" with \", _jsx(_components.code, {\n children: \"error.details\"\n }), \" naming \", _jsx(_components.code, {\n children: \"custom_attributes.\u003ckey>\"\n }), \", and nothing is written.\"]\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":"Update a company","openapi":"api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/companies/{companyId}","description":"A partial update of `name`, `description` and `custom_attributes`. Fields you leave out keep their current value.\n\n`custom_attributes` is **merged**, not replaced: send only the keys you want to change, and send a key as `null` to clear it. Changing a parent attribute can also clear the conditional attributes that depend on it, including ones hidden or read-only for your role; the response shows what remains of the attributes you can see. Each key must be a company attribute of the account and each value must fit its definition — a list attribute only accepts one of its options — or the call answers `422` and nothing is written.\n\n`domain` and `labels` cannot be changed here, but sending them unchanged is accepted, so you can send back a company you read: a `domain` equal to the current one (compared after normalization, or `null` when the company has none), and `labels` equal to the current ones in any order. A real change of either answers `400` with `error.details` naming `domain` or `labels` (code `not_editable`), and nothing is saved. Unchanged `domain` and `labels` do not count as fields to update: a payload with none of `name`, `description` or `custom_attributes` answers `400` as empty.\n\nAn assistant cannot update companies. Other roles can, except for attributes that are read-only or hidden for their role: sending one of those answers `403` with `error.details` naming `custom_attributes.\u003ckey>`, and nothing is written.","href":"/api-reference/cloudchat/endpoints/update-a-company"}}},"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":"updateCompany","summary":"Update a company","description":"A partial update of `name`, `description` and `custom_attributes`. Fields you leave out keep their current value.\n\n`custom_attributes` is **merged**, not replaced: send only the keys you want to change, and send a key as `null` to clear it. Changing a parent attribute can also clear the conditional attributes that depend on it, including ones hidden or read-only for your role; the response shows what remains of the attributes you can see. Each key must be a company attribute of the account and each value must fit its definition — a list attribute only accepts one of its options — or the call answers `422` and nothing is written.\n\n`domain` and `labels` cannot be changed here, but sending them unchanged is accepted, so you can send back a company you read: a `domain` equal to the current one (compared after normalization, or `null` when the company has none), and `labels` equal to the current ones in any order. A real change of either answers `400` with `error.details` naming `domain` or `labels` (code `not_editable`), and nothing is saved. Unchanged `domain` and `labels` do not count as fields to update: a payload with none of `name`, `description` or `custom_attributes` answers `400` as empty.\n\nAn assistant cannot update companies. Other roles can, except for attributes that are read-only or hidden for their role: sending one of those answers `403` with `error.details` naming `custom_attributes.\u003ckey>`, and nothing is written.","tags":["Companies"],"requestBody":"a32e00db-94ef-4680-bd0a-161be26c7dad","responses":{"200":"b063c43e-ce4b-4672-bf96-6384c886f153","400":"0b103d84-fe4b-4402-8956-72cb2b781cac","401":"5f4fbaf8-a6f6-4025-a239-9562ca223968","403":"e71811d7-1e2e-4d0a-bfd8-3b529662ea51","404":"a7410715-0e17-44f4-9b4d-4d14b55a555d","422":"1dbc1398-3f7c-4044-85fd-3990b32a50ab","429":"66154d0c-d8c4-400d-87ba-d0117f504aed","500":"be66cf99-1568-4599-a837-e36d93c30f96"},"method":"patch","type":"path","servers":["637d0dd3-371a-440d-839a-2f45e44ca8d7"],"security":["4e01eef1-bc6b-4f11-84c7-1ecf76588784"],"path":"/v1/accounts/{accountId}/companies/{companyId}","baseUrlOptions":["https://api.cloudhumans.com/cloudchat"],"title":"Update a company","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b406bed5-ceea-42dd-bf87-f787f63695ec":{"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"}},"7bf6eaee-1feb-4699-99c0-ad76279afeb2":{"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"}},"446b7d99-2ad3-4dd0-a9ba-52fb8b7f6a44":{"name":"companyId","in":"path","required":true,"description":"The `id` returned when the company was listed. A company of another account answers `404`, the same as an id that does not exist.","schema":{"type":"integer","example":314,"isRequired":true,"description":"The `id` returned when the company was listed. A company of another account answers `404`, the same as an id that does not exist.","uniqueKey":"","typeLabel":"integer"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company"],"properties":{"company":{"type":"object","minProperties":1,"description":"At least one of the three fields. Whatever you omit is left as it is. `domain` and `labels` are not editable here: sending them equal to the current values is accepted and ignored, while a different value answers `400` and nothing is saved.","properties":{"name":{"type":"string","example":"Transportadora Rápida","uniqueKey":"company.name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","example":"Transportadora parceira para entregas no Sudeste.","uniqueKey":"company.description.oneOf.0","typeLabel":"string"},{"type":"null","example":"Transportadora parceira para entregas no Sudeste.","uniqueKey":"company.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"company.description","typeLabel":"string | null"},"custom_attributes":{"type":"object","description":"Merged into the attributes the company already has: keys you send are written, keys you leave out keep their value. Send a key as `null` to clear it.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"company.custom_attributes.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"company.custom_attributes.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"company.custom_attributes.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"array","items":{"type":"string","uniqueKey":"company.custom_attributes.additionalProperties.oneOf.3.items.[INDEX]","typeLabel":"string"},"uniqueKey":"company.custom_attributes.additionalProperties.oneOf.3","typeLabel":"string[]"},{"type":"null","uniqueKey":"company.custom_attributes.additionalProperties.oneOf.4","typeLabel":"null"}],"uniqueKey":"company.custom_attributes.additionalProperties","typeLabel":"string | number | boolean | string[] | null"},"example":{"rm_responsavel":"Ana Lima","operacoes":["Last mile","Reversa"]},"uniqueKey":"company.custom_attributes","typeLabel":"object"}},"isRequired":true,"uniqueKey":"company","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"company":{"custom_attributes":{"rm_responsavel":"Ana Lima","operacoes":["Last mile","Reversa"]}}},"examples":{"Example":{"title":"Example","value":{"company":{"custom_attributes":{"rm_responsavel":"Ana Lima","operacoes":["Last mile","Reversa"]}}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"b063c43e-ce4b-4672-bf96-6384c886f153":{"description":"Updated, with the values now stored.","content":{"application/json":{"schema":{"type":"object","description":"A company of the account.","required":["id","name","domain","description","contacts_count","labels","custom_attributes","created_at","updated_at"],"properties":{"id":{"type":"integer","description":"The company id. Send it as `companyId` or `company_id` to the other company operations.","example":314,"isRequired":true,"uniqueKey":"id","typeLabel":"integer"},"name":{"type":"string","description":"The company name.","example":"Transportadora Rápida","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"domain":{"oneOf":[{"type":"string","description":"The company's web domain, `null` when it has none. Read-only through this API.","example":"rapida.com.br","isRequired":true,"uniqueKey":"domain.oneOf.0","typeLabel":"string"},{"type":"null","description":"The company's web domain, `null` when it has none. Read-only through this API.","example":"rapida.com.br","isRequired":true,"uniqueKey":"domain.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"domain","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"Free text about the company, `null` when it has none.","example":"Transportadora parceira para entregas no Sudeste.","isRequired":true,"uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Free text about the company, `null` when it has none.","example":"Transportadora parceira para entregas no Sudeste.","isRequired":true,"uniqueKey":"description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"description","typeLabel":"string | null"},"contacts_count":{"type":"integer","description":"How many contacts are linked to the company.","example":3,"isRequired":true,"uniqueKey":"contacts_count","typeLabel":"integer"},"labels":{"type":"array","description":"The labels on the company, by name. An empty array when it has none.","items":{"type":"string","uniqueKey":"labels.items.[INDEX]","typeLabel":"string"},"example":["transportadora"],"isRequired":true,"uniqueKey":"labels","typeLabel":"string[]"},"custom_attributes":{"type":"object","description":"The company's custom attributes, keyed by attribute key. A value is a string, a number, a boolean or an array of strings (for a multi-select list). An attribute your role cannot see is left out entirely, not returned as `null`, so a missing key can mean either \"not set\" or \"not visible to you\". An empty object when none are set.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"custom_attributes.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"custom_attributes.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"custom_attributes.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"array","items":{"type":"string","uniqueKey":"custom_attributes.additionalProperties.oneOf.3.items.[INDEX]","typeLabel":"string"},"uniqueKey":"custom_attributes.additionalProperties.oneOf.3","typeLabel":"string[]"}],"uniqueKey":"custom_attributes.additionalProperties","typeLabel":"string | number | boolean | string[]"},"example":{"cnpj":"12345678000190","rm_responsavel":"Ana Lima","operacoes":["Last mile","Reversa"]},"isRequired":true,"uniqueKey":"custom_attributes","typeLabel":"object"},"created_at":{"type":"string","format":"date-time","description":"When the company was created. ISO 8601 in UTC, with milliseconds.","example":"2026-08-14T12:30:05.412Z","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"When the company was last changed, in the same format.","example":"2026-10-28T17:02:41.903Z","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":314,"name":"Transportadora Rápida","domain":"rapida.com.br","description":"Transportadora parceira para entregas no Sudeste.","contacts_count":3,"labels":["transportadora"],"custom_attributes":{"cnpj":"12345678000190","rm_responsavel":"Ana Lima","operacoes":["Last mile","Reversa"]},"created_at":"2026-08-14T12:30:05.412Z","updated_at":"2026-10-28T17:02:41.903Z"},"examples":{"Example":{"title":"Example","value":{"id":314,"name":"Transportadora Rápida","domain":"rapida.com.br","description":"Transportadora parceira para entregas no Sudeste.","contacts_count":3,"labels":["transportadora"],"custom_attributes":{"cnpj":"12345678000190","rm_responsavel":"Ana Lima","operacoes":["Last mile","Reversa"]},"created_at":"2026-08-14T12:30:05.412Z","updated_at":"2026-10-28T17:02:41.903Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"0b103d84-fe4b-4402-8956-72cb2b781cac":{"description":"Malformed request, a body with no `company` object, a `company` that changes `domain` or `labels`, a payload with none of `name`, `description` or `custom_attributes`, or a `custom_attributes` that is not an object. In the last three cases `error.details` names `domain` or `labels` (code `not_editable`), `company` or `custom_attributes`.","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":"bad_request","message":"The request is malformed.","details":[{"field":"company","code":"empty","message":"Provide at least one of name, description or custom_attributes inside company."}]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"bad_request","message":"The request is malformed.","details":[{"field":"company","code":"empty","message":"Provide at least one of name, description or custom_attributes inside company."}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"5f4fbaf8-a6f6-4025-a239-9562ca223968":{"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"},"e71811d7-1e2e-4d0a-bfd8-3b529662ea51":{"description":"Refused. Besides the causes every operation in this group shares — companies not enabled for the account, a suspended account — an assistant cannot update companies, and no role can write an attribute that is read-only or hidden for it. In that last case `error.details` has one entry per refused key, named `custom_attributes.\u003ckey>`, and nothing was written.","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":"You are not allowed to perform this action.","details":[{"field":"custom_attributes.cnpj","code":"forbidden","message":"You are not allowed to change this attribute."}]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"forbidden","message":"You are not allowed to perform this action.","details":[{"field":"custom_attributes.cnpj","code":"forbidden","message":"You are not allowed to change this attribute."}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"a7410715-0e17-44f4-9b4d-4d14b55a555d":{"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"},"1dbc1398-3f7c-4044-85fd-3990b32a50ab":{"description":"The payload was understood but a value is not acceptable, and nothing was written. `details` names the offending field: `name` or `description` for those fields, `custom_attributes` for any attribute problem — a key that is not a company attribute of the account, a list attribute set to a value outside its options, or a value that does not match the attribute's format. For an attribute problem the entry's `code` carries the same text as its `message`, which names the key; match on `field`, not on the text.","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":"custom_attributes","code":"segmento is not a company custom attribute","message":"segmento is not a company custom attribute"}]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"validation_failed","message":"The request payload is invalid.","details":[{"field":"custom_attributes","code":"segmento is not a company custom attribute","message":"segmento is not a company custom attribute"}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"66154d0c-d8c4-400d-87ba-d0117f504aed":{"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"},"be66cf99-1568-4599-a837-e36d93c30f96":{"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":"Update a company - Cloud Chat","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-16T17:29:10.853Z","originalFileLocation":"api-reference/cloudchat/endpoints/update-a-company.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=\"A partial update of name, description and custom_attributes. Fields you leave out keep their current value. custom_attributes is merged, not replaced: send only the keys you want to change, and send a key as null to clear it. Changing a parent attribute can also clear the conditional attributes that depend on it, including ones hidden or read-only for your role; the response shows what remains of the attributes you can see. Each key must be a company attribute of the account and each value must fit its definition — a list attribute only accepts one of its options — or the call answers 422 and nothing is written. domain and labels cannot be changed here, but sending them unchanged is accepted, so you can send back a company you read: a domain equal to the current one (compared after normalization, or null when the company has none), and labels equal to the current ones in any order. A real change of either answers 400 with error.details naming domain or labels (code not_editable), and nothing is saved. Unchanged domain and labels do not count as fields to update: a payload with none of name, description or custom_attributes answers 400 as empty. An assistant cannot update companies. Other roles can, except for attributes that are read-only or hidden for their role: sending one of those answers 403 with error.details naming custom_attributes., and nothing is written.\">\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=\"Update a company - Cloud Chat\">\u003cmeta data-mint-head property=\"og:description\" content=\"A partial update of name, description and custom_attributes. Fields you leave out keep their current value. custom_attributes is merged, not replaced: send only the keys you want to change, and send a key as null to clear it. Changing a parent attribute can also clear the conditional attributes that depend on it, including ones hidden or read-only for your role; the response shows what remains of the attributes you can see. Each key must be a company attribute of the account and each value must fit its definition — a list attribute only accepts one of its options — or the call answers 422 and nothing is written. domain and labels cannot be changed here, but sending them unchanged is accepted, so you can send back a company you read: a domain equal to the current one (compared after normalization, or null when the company has none), and labels equal to the current ones in any order. A real change of either answers 400 with error.details naming domain or labels (code not_editable), and nothing is saved. Unchanged domain and labels do not count as fields to update: a payload with none of name, description or custom_attributes answers 400 as empty. An assistant cannot update companies. Other roles can, except for attributes that are read-only or hidden for their role: sending one of those answers 403 with error.details naming custom_attributes., and nothing is written.\">\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/update-a-company\">\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=Companies\u0026amp;title=Update+a+company\u0026amp;description=A+partial+update+of+%60name%60%2C+%60description%60+and+%60custom_attributes%60.+Fields+you+leave+out+keep+their+current+value.%0A%0A%60custom_attributes%60+is+**merged**%2C+not+replac\u0026amp;theme=f1ab87c694400f10daae88f8\u0026amp;signature=56f031605bbe303d8ffe8f8e0e59e8bb737662f4d940a5c4598cb939b7f9b1aa\">\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=\"Update a company - Cloud Chat\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"A partial update of name, description and custom_attributes. Fields you leave out keep their current value. custom_attributes is merged, not replaced: send only the keys you want to change, and send a key as null to clear it. Changing a parent attribute can also clear the conditional attributes that depend on it, including ones hidden or read-only for your role; the response shows what remains of the attributes you can see. Each key must be a company attribute of the account and each value must fit its definition — a list attribute only accepts one of its options — or the call answers 422 and nothing is written. domain and labels cannot be changed here, but sending them unchanged is accepted, so you can send back a company you read: a domain equal to the current one (compared after normalization, or null when the company has none), and labels equal to the current ones in any order. A real change of either answers 400 with error.details naming domain or labels (code not_editable), and nothing is saved. Unchanged domain and labels do not count as fields to update: a payload with none of name, description or custom_attributes answers 400 as empty. An assistant cannot update companies. Other roles can, except for attributes that are read-only or hidden for their role: sending one of those answers 403 with error.details naming custom_attributes., and nothing is written.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cloud-humans.mintlify.site/_mintlify/api/og/v2?division=Companies\u0026amp;title=Update+a+company\u0026amp;description=A+partial+update+of+%60name%60%2C+%60description%60+and+%60custom_attributes%60.+Fields+you+leave+out+keep+their+current+value.%0A%0A%60custom_attributes%60+is+**merged**%2C+not+replac\u0026amp;theme=f1ab87c694400f10daae88f8\u0026amp;signature=56f031605bbe303d8ffe8f8e0e59e8bb737662f4d940a5c4598cb939b7f9b1aa\">\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/update-a-company\">\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/update-a-company.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/update-a-company#webpage\",\"url\":\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/update-a-company\",\"name\":\"Update a company\",\"description\":\"A partial update of name, description and custom_attributes. Fields you leave out keep their current value. custom_attributes is merged, not replaced: send only the keys you want to change, and send a key as null to clear it. Changing a parent attribute can also clear the conditional attributes that depend on it, including ones hidden or read-only for your role; the response shows what remains of the attributes you can see. Each key must be a company attribute of the account and each value must fit its definition — a list attribute only accepts one of its options — or the call answers 422 and nothing is written. domain and labels cannot be changed here, but sending them unchanged is accepted, so you can send back a company you read: a domain equal to the current one (compared after normalization, or null when the company has none), and labels equal to the current ones in any order. A real change of either answers 400 with error.details naming domain or labels (code not_editable), and nothing is saved. Unchanged domain and labels do not count as fields to update: a payload with none of name, description or custom_attributes answers 400 as empty. An assistant cannot update companies. Other roles can, except for attributes that are read-only or hidden for their role: sending one of those answers 403 with error.details naming custom_attributes., and nothing is written.\",\"dateModified\":\"2026-11-16T17:29:10.853Z\",\"isPartOf\":{\"@id\":\"https://docs.cloudhumans.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/update-a-company#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/update-a-company#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Companies\",\"item\":\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/list-companies\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update a company\",\"item\":\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/update-a-company\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/update-a-company#apireference\",\"headline\":\"Update a company\",\"name\":\"Update a company\",\"description\":\"A partial update of name, description and custom_attributes. Fields you leave out keep their current value. custom_attributes is merged, not replaced: send only the keys you want to change, and send a key as null to clear it. Changing a parent attribute can also clear the conditional attributes that depend on it, including ones hidden or read-only for your role; the response shows what remains of the attributes you can see. Each key must be a company attribute of the account and each value must fit its definition — a list attribute only accepts one of its options — or the call answers 422 and nothing is written. domain and labels cannot be changed here, but sending them unchanged is accepted, so you can send back a company you read: a domain equal to the current one (compared after normalization, or null when the company has none), and labels equal to the current ones in any order. A real change of either answers 400 with error.details naming domain or labels (code not_editable), and nothing is saved. Unchanged domain and labels do not count as fields to update: a payload with none of name, description or custom_attributes answers 400 as empty. An assistant cannot update companies. Other roles can, except for attributes that are read-only or hidden for their role: sending one of those answers 403 with error.details naming custom_attributes., and nothing is written.\",\"url\":\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/update-a-company\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cloudhumans.com/api-reference/cloudchat/endpoints/update-a-company#webpage\"},\"dateModified\":\"2026-11-16T17:29:10.853Z\",\"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/update-a-company.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","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","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}","description":"Returns one company, with its labels and the custom attributes your role can see.\n\nA company of another account answers `404`, the same as an id that does not exist.","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","description":"Returns every company linked to the contact, one page at a time, oldest link first (by when the link was created, then by id), so the order is stable across pages. `primary` flags the contact's main company. Walk the pages while `meta.has_next` is true.\n\nA contact of another account answers `404`, the same as an id that does not exist.","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":"Update a company - 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"]}