Replaces the text of an AI suggestion: the draft reply the AI writes in assist mode for a teammate to review. Nothing is sent to the contact. The teammate still reviews the draft and sends it.Find the suggestion with List chat session history: it is an event of type ai_suggestion, and its id is the suggestion_id here. Write text in the language the reply should reach the contact in.
{ "text": "Your refund was issued on the 14th and should reach your card within 5 business days."}
The response is the updated ai_suggestion event, in the same shape the history returns.
Translated sessions: the translated copy your team reads is rebuilt from the new text. A teammate who still has the earlier version in the composer sends their reply as written; the contact never gets new text or images that teammate hasn’t seen.
Activity log: every edit is recorded with the API key, Companion user or mini-app that made it.
Connected helpdesks: a copy of the draft that was already posted to your helpdesk (for example as an internal note) keeps its original text.
Not found (404): the id is not a live AI suggestion of the session in the path, or the draft or session was redacted. Replies already sent to the contact, internal notes and other events can’t be edited here.
Authorizations
Authorization
string
header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"OpenCX Docs","description":"Documentation for OpenCX, an AI-powered omnichannel customer support platform. Build AI agents for chat, phone, email, WhatsApp, and SMS with knowledge bases, actions, and human handoff.","colors":{"primary":"#0A0A0A","light":"#FAFAFA","dark":"#0A0A0A"},"logo":{"light":"https://mintcdn.com/openchat/ivWwffb57vEmukK4/logo-light.svg?fit=max\u0026auto=format\u0026n=ivWwffb57vEmukK4\u0026q=85\u0026s=f6a5e94f4909a4d8df45757989c11afe","dark":"https://mintcdn.com/openchat/ivWwffb57vEmukK4/logo.svg?fit=max\u0026auto=format\u0026n=ivWwffb57vEmukK4\u0026q=85\u0026s=84cc8ee0de542d166e76b53651f4f4e8"},"favicon":"https://mintcdn.com/openchat/ivWwffb57vEmukK4/favicon.png?fit=max\u0026auto=format\u0026n=ivWwffb57vEmukK4\u0026q=85\u0026s=68fa269328f9c95d4404b9073ac8aa37","api":{"openapi":"https://api.open.cx/api-json","playground":{"display":"interactive"},"mdx":{"server":"https://api.open.cx"}},"appearance":{"default":"dark","strict":false},"background":{"decoration":"gradient","color":{"light":"#FFFFFF","dark":"#0A0A0A"}},"navbar":{"links":[{"href":"https://platform.open.cx","label":"Dashboard"}],"primary":{"type":"button","label":"Get Started","href":"https://open.cx"}},"seo":{"metatags":{"og:type":"website","og:site_name":"OpenCX Docs"},"indexing":"all"},"fonts":{"heading":{"family":"Inter Tight"},"body":{"family":"Inter"}},"styling":{"eyebrows":"section","codeblocks":"dark","latex":true},"contextual":{"options":["copy","view","claude","chatgpt"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"openchat","hasAudioNarration":false,"actualSubdomain":"openchat","customDomains":["docs.open.cx"],"gitSource":{"type":"github","owner":"opencx-labs","repo":"opencx","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{},"buildId":"6b01f6c60027a935336611b3","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":580},{"language":"default","tag":"Integrations","count":210},{"language":"default","tag":"AI agent","count":132},{"language":"default","tag":"Ticketing Systems","count":132},{"language":"default","tag":"Channels","count":118},{"language":"default","tag":"Sessions and inbox","count":112},{"language":"default","tag":"Build Agents","count":79},{"language":"default","tag":"Agent Training","count":58},{"language":"default","tag":"Teams and routing","count":57},{"language":"default","tag":"Customers","count":53}]},"assistantConfig":{},"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":"site-roles","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":true},"customCss":[{"filePath":"style.css","content":":root{--radius: 0.375rem;--radius-sm: 0.125rem;--radius-md: 0.25rem;--radius-lg: 0.375rem;--radius-xl: 0.75rem;--radius-2xl: 1.125rem;--radius-3xl: 1.5rem;--radius-full: 9999px}card,.card,card-group card,.card-group card,.card-group .card{border-radius:var(--radius-3xl)}callout,.callout,accordion,accordion-group accordion,.accordion,.accordion-group .accordion,[data-accordion],[data-accordion-item]{border-radius:var(--radius-xl)}pre,pre>code,pre.shiki,figure.shiki,div[class*=\"language-\"],div[class*=\"language-\"] pre{border-radius:var(--radius-xl)}#topbar-cta-button>a,#topbar-cta-button>a>span.absolute{border-radius:var(--radius-xl)}#search-bar-entry{border-radius:var(--radius-xl)}.zendesk-flow .zendesk-flow-frame{border-radius:var(--radius-xl)}.integration-orbit a[href]{touch-action:manipulation}.integration-orbit a[href] img{pointer-events:none}:root{--docs-context-bg: #ffffff;--docs-context-bg-hover: #f5f5f5;--docs-context-border: rgba(10, 10, 10, 0.16);--docs-context-border-strong: rgba(10, 10, 10, 0.32);--docs-context-text: #0a0a0a;--docs-context-muted: rgba(10, 10, 10, 0.6);--docs-context-accent: #0a0a0a;--docs-context-trigger-bg:\n linear-gradient(180deg, rgba(10, 10, 10, 0.04), transparent 48%),\n var(--docs-context-bg);--docs-context-trigger-bg-hover:\n linear-gradient(180deg, rgba(10, 10, 10, 0.07), transparent 52%),\n var(--docs-context-bg-hover);--docs-context-trigger-shadow:\n inset 0 1px 0 rgba(255, 255, 255, 0.9),\n 0 1px 2px rgba(15, 23, 42, 0.04);--docs-context-menu-bg:\n radial-gradient(circle at top right, rgba(10, 10, 10, 0.05), transparent 38%),\n linear-gradient(180deg, #ffffff, #fafafa);--docs-context-menu-border: rgba(10, 10, 10, 0.14);--docs-context-menu-shadow:\n 0 24px 60px rgba(15, 23, 42, 0.16),\n 0 0 0 1px rgba(10, 10, 10, 0.06);--docs-context-hover-text: #0a0a0a;--docs-context-item-hover: rgba(10, 10, 10, 0.06);--docs-context-divider: rgba(10, 10, 10, 0.1)}html.dark{--docs-context-bg: #0a0a0a;--docs-context-bg-hover: #161616;--docs-context-border: rgba(255, 255, 255, 0.2);--docs-context-border-strong: rgba(255, 255, 255, 0.36);--docs-context-text: #fafafa;--docs-context-muted: rgba(250, 250, 250, 0.72);--docs-context-accent: #fafafa;--docs-context-trigger-bg:\n linear-gradient(180deg, rgba(255, 255, 255, 0.06), transparent 42%),\n var(--docs-context-bg);--docs-context-trigger-bg-hover:\n linear-gradient(180deg, rgba(255, 255, 255, 0.1), transparent 48%),\n var(--docs-context-bg-hover);--docs-context-trigger-shadow:\n inset 0 1px 0 rgba(255, 255, 255, 0.05),\n 0 0 0 1px rgba(255, 255, 255, 0.08);--docs-context-menu-bg:\n radial-gradient(circle at top right, rgba(255, 255, 255, 0.08), transparent 34%),\n linear-gradient(180deg, #121212, #050505);--docs-context-menu-border: rgba(255, 255, 255, 0.14);--docs-context-menu-shadow:\n 0 24px 60px rgba(0, 0, 0, 0.42),\n 0 0 0 1px rgba(255, 255, 255, 0.08);--docs-context-hover-text: #ffffff;--docs-context-item-hover: rgba(255, 255, 255, 0.1);--docs-context-divider: rgba(255, 255, 255, 0.12)}#page-context-menu-button,#page-context-menu button[aria-label=\"More actions\"]{color:var(--docs-context-text)!important;background:var(--docs-context-trigger-bg)!important;border-color:var(--docs-context-border)!important;box-shadow:var(--docs-context-trigger-shadow)}#page-context-menu-button{border-right-color:var(--docs-context-divider)!important}#page-context-menu-button svg,#page-context-menu button[aria-label=\"More actions\"] svg{color:var(--docs-context-accent)!important}#page-context-menu-button:hover,#page-context-menu button[aria-label=\"More actions\"]:hover,#page-context-menu button[aria-label=\"More actions\"][data-state=\"open\"]{color:var(--docs-context-hover-text)!important;background:var(--docs-context-trigger-bg-hover)!important;border-color:var(--docs-context-border-strong)!important}body [data-radix-popper-content-wrapper] [role=\"menu\"]{color:var(--docs-context-text)!important;background:var(--docs-context-menu-bg)!important;border:1px solid var(--docs-context-menu-border)!important;border-radius:var(--radius-xl)!important;box-shadow:var(--docs-context-menu-shadow)!important}body [data-radix-popper-content-wrapper] [role=\"menuitem\"]{color:var(--docs-context-text)!important;border-radius:var(--radius-lg)!important}body [data-radix-popper-content-wrapper] [role=\"menuitem\"] *{color:var(--docs-context-text)!important}body [data-radix-popper-content-wrapper] [role=\"menuitem\"] svg{color:var(--docs-context-accent)!important}body [data-radix-popper-content-wrapper] [role=\"menuitem\"] [class*=\"text-gray\"],body [data-radix-popper-content-wrapper] [role=\"menuitem\"] [class*=\"text-slate\"],body [data-radix-popper-content-wrapper] [role=\"menuitem\"] [class*=\"text-zinc\"],body [data-radix-popper-content-wrapper] [role=\"menuitem\"] [class*=\"text-white\"],body [data-radix-popper-content-wrapper] [role=\"menuitem\"] p{color:var(--docs-context-muted)!important}body [data-radix-popper-content-wrapper] [role=\"menuitem\"]:hover,body [data-radix-popper-content-wrapper] [role=\"menuitem\"][data-highlighted]{color:var(--docs-context-hover-text)!important;background:var(--docs-context-item-hover)!important}html:not(.dark) #sidebar{border-right:1px solid #e5e5e5!important}html.dark #sidebar{border-right:1px solid #262626!important}#sidebar,#sidebar-content,#sidebar *,#sidebar-content *{scrollbar-color:rgba(113, 113, 122, 0.4) transparent}#sidebar ::-webkit-scrollbar,#sidebar-content ::-webkit-scrollbar{width:8px;background:transparent}#sidebar ::-webkit-scrollbar-track,#sidebar ::-webkit-scrollbar-corner,#sidebar-content ::-webkit-scrollbar-track,#sidebar-content ::-webkit-scrollbar-corner{background:transparent}#sidebar ::-webkit-scrollbar-thumb,#sidebar-content ::-webkit-scrollbar-thumb{background-color:rgba(113, 113, 122, 0.4);border-radius:9999px!important;border:2px solid transparent;background-clip:content-box}#sidebar ::-webkit-scrollbar-thumb:hover,#sidebar-content ::-webkit-scrollbar-thumb:hover{background-color:rgba(113, 113, 122, 0.7)}html.dark #sidebar,html.dark #sidebar-content,html.dark #sidebar *,html.dark #sidebar-content *{scrollbar-color:rgba(161, 161, 170, 0.35) transparent}html.dark #sidebar ::-webkit-scrollbar-thumb,html.dark #sidebar-content ::-webkit-scrollbar-thumb{background-color:rgba(161, 161, 170, 0.35)}html.dark #sidebar ::-webkit-scrollbar-thumb:hover,html.dark #sidebar-content ::-webkit-scrollbar-thumb:hover{background-color:rgba(161, 161, 170, 0.6)}#sidebar-content>div>div.sticky.top-0.pointer-events-none.bg-gradient-to-b{background-image:none!important}html.dark #sidebar img[src*=\"/images/mcp/cursor.svg\"],html.dark #sidebar img[src*=\"/images/mcp/claude.svg\"],html.dark #sidebar img[src*=\"/images/mcp/windsurf.svg\"],html.dark #sidebar img[src*=\"/images/mcp/zed.svg\"]{filter:invert(1) brightness(0.92)}#navbar{box-shadow:none!important;row-gap:0.25rem!important}html:not(.dark) #navbar{border-bottom:1px solid #e2e8f0!important}html.dark #navbar{border-bottom:1px solid #3f463f!important}#navbar #header,#navbar #navigation-items,#navbar navigation-items{border-bottom:none!important;box-shadow:none!important}#navbar nav-tabs,#navbar .nav-tabs{border-top:none!important;border-top-width:0!important;box-shadow:none!important}#navbar .h-16 .h-full.relative.flex-1.flex.items-center.gap-x-4.min-w-0{border-bottom:none!important;border-bottom-width:0!important;box-shadow:none!important}:not(pre)>code:is(.dark *){color:rgb(var(--primary-light))}:not(pre)>code{color:rgb(var(--primary))}html.dark{--primary: 250 250 250;--primary-light: 245 245 245;--primary-dark: 10 10 10}html:not(.dark) #search-bar-entry{background-color:#ffffff!important;color:#404040}html:not(.dark) #navbar div.backdrop-blur{backdrop-filter:blur(14px) saturate(180%)!important;-webkit-backdrop-filter:blur(14px) saturate(180%)!important;background-color:rgba(255, 255, 255, 0.72)!important}html.dark #navbar div.backdrop-blur{backdrop-filter:blur(6px) saturate(125%)!important;-webkit-backdrop-filter:blur(6px) saturate(125%)!important;background-color:rgba(10, 10, 10, 0.6)!important}html:not(.dark) #topbar-cta-button>a>span.absolute{background-color:#0a0a0a!important}html:not(.dark) #topbar-cta-button>a .text-white{color:#fafafa!important}html.dark #topbar-cta-button>a>span.absolute{background-color:#fafafa!important}html.dark #topbar-cta-button>a .text-white{color:#0a0a0a!important}html.dark #topbar-cta-button>a svg{color:#0a0a0a!important}.nav-tabs-item>svg,.nav-tabs-item>span>svg:first-child{display:none!important}.toc-item{padding-left:12px!important;border-left:2px solid rgba(148, 163, 184, 0.22)!important;transition:border-color 0.18s ease, color 0.18s ease}html.dark .toc-item{border-left-color:rgba(148, 163, 184, 0.2)!important}.toc-item:hover{border-left-color:rgba(10, 10, 10, 0.45)!important}html.dark .toc-item:hover{border-left-color:rgba(250, 250, 250, 0.55)!important}.toc-item:has(>a[class*=\"text-primary\"]),.toc-item:has(>a[style*=\"color\"]){border-left-color:rgb(var(--primary))!important}html.dark .toc-item:has(>a[class*=\"text-primary\"]),html.dark .toc-item:has(>a[style*=\"color\"]){border-left-color:rgb(var(--primary-light))!important}button[data-state][aria-label],button[data-state][aria-label]>*,span.tooltip{cursor:help!important}#navbar .h-16 .h-full.relative.flex-1.flex.items-center.gap-x-4.min-w-0{border-bottom:none!important;border-bottom-width:0!important;box-shadow:none!important}#navbar .h-16 img[src*=\"logo-light\"],#navbar .h-16 img[src*=\"logo.svg\"]{transform:scale(1.1);transform-origin:left center}#navbar .h-16>div>div:has(#search-bar-entry){justify-content:flex-end!important}#navbar .h-16>div>div.ml-auto.justify-end{flex:0 0 auto!important}.integration-orbit-grid-fade{background-image:linear-gradient(to right, rgb(0 0 0 / 0.07) 1px, transparent 1px),\n linear-gradient(to bottom, rgb(0 0 0 / 0.07) 1px, transparent 1px);background-size:16px 16px;background-position:center center;-webkit-mask-image:radial-gradient(\n 72% 72% at 50% 50%,\n #000 0%,\n #000 38%,\n transparent 82%\n );mask-image:radial-gradient(72% 72% at 50% 50%, #000 0%, #000 38%, transparent 82%)}html.dark .integration-orbit-grid-fade{background-image:linear-gradient(to right, rgb(255 255 255 / 0.08) 1px, transparent 1px),\n linear-gradient(to bottom, rgb(255 255 255 / 0.08) 1px, transparent 1px)}.animate-orbit{animation:orbit var(--duration) linear infinite}@keyframes orbit{0%{transform:rotate(calc(var(--angle) * 1deg))\n translateY(calc(var(--orbit-radius) * -1px))\n rotate(calc(var(--angle) * -1deg))}100%{transform:rotate(calc(var(--angle) * 1deg + 360deg))\n translateY(calc(var(--orbit-radius) * -1px))\n rotate(calc(var(--angle) * -1deg - 360deg))}}.zendesk-flow-frame{background-image:radial-gradient(ellipse 80% 50% at 50% 50%, rgb(34 197 94 / 0.04), transparent 70%)}html.dark .zendesk-flow-frame{background-image:radial-gradient(ellipse 80% 50% at 50% 50%, rgb(34 197 94 / 0.06), transparent 70%)}.zendesk-flow-grid{background-image:linear-gradient(to right, rgb(0 0 0 / 0.05) 1px, transparent 1px),\n linear-gradient(to bottom, rgb(0 0 0 / 0.05) 1px, transparent 1px);background-size:24px 24px;background-position:center center;-webkit-mask-image:radial-gradient(80% 70% at 50% 50%, #000 0%, #000 45%, transparent 90%);mask-image:radial-gradient(80% 70% at 50% 50%, #000 0%, #000 45%, transparent 90%)}html.dark .zendesk-flow-grid{background-image:linear-gradient(to right, rgb(255 255 255 / 0.05) 1px, transparent 1px),\n linear-gradient(to bottom, rgb(255 255 255 / 0.05) 1px, transparent 1px)}.chat-assistant-floating-input,[class*=\"chat-assistant-floating\"]{display:none!important}html.dark [data-opencx-root] [style*=\"--opencx-background\"]{--opencx-background: 0 0% 9% !important;--opencx-foreground: 0 0% 98% !important;--opencx-secondary: 0 0% 14.9% !important;--opencx-accent: 0 0% 14.9% !important;--opencx-muted: 0 0% 14.9% !important;--opencx-muted-foreground: 0 0% 63.9% !important;--opencx-border: 0 0% 25.1% !important;--opencx-input: 0 0% 25.1% !important}[data-opencx-root] iframe{color-scheme:light}html.dark [data-opencx-root] iframe{color-scheme:dark}#footer{display:none!important}.docs-footer{margin-top:5rem;padding-top:3rem;padding-bottom:1.5rem;border-top:1px solid rgba(228, 228, 231, 0.7);font-size:0.875rem;color:rgb(82 82 91);line-height:1.5}html.dark .docs-footer{border-top-color:rgba(63, 63, 70, 0.35);color:rgb(161 161 170)}.docs-footer__top{display:flex;flex-direction:column;gap:2.5rem;padding-bottom:2.5rem;border-bottom:1px solid rgba(228, 228, 231, 0.55)}html.dark .docs-footer__top{border-bottom-color:rgba(63, 63, 70, 0.25)}@media (min-width: 768px){.docs-footer__top{flex-direction:row;gap:3rem}}.docs-footer__brand{display:flex;flex-direction:column;gap:0.75rem;max-width:16rem;flex-shrink:0}@media (min-width: 768px){.docs-footer__brand{width:16rem}}.docs-footer__logo-link{display:inline-flex;width:fit-content}.docs-footer__logo{height:1.75rem;width:auto}.docs-footer__logo--dark{display:none}html.dark .docs-footer__logo--light{display:none}html.dark .docs-footer__logo--dark{display:inline-block}.docs-footer__desc{margin:0.25rem 0 0;font-size:0.8125rem;line-height:1.55;color:rgb(63 63 70)}html.dark .docs-footer__desc{color:rgb(212 212 216)}.docs-footer__label{margin:0.75rem 0 0.25rem;font-size:0.6875rem;font-weight:600;letter-spacing:0.1em;text-transform:uppercase;color:rgb(82 82 91)}html.dark .docs-footer__label{color:rgb(161 161 170)}.docs-footer__socials{display:inline-flex;gap:0.875rem;align-items:center}.docs-footer__socials a{display:inline-flex;align-items:center;justify-content:center;color:rgb(24 24 27);transition:opacity 0.15s ease}.docs-footer__socials a:hover{opacity:0.65}html.dark .docs-footer__socials a{color:rgb(244 244 245)}html.dark .docs-footer__socials a:hover{opacity:0.7}.docs-footer__columns{flex:1;display:grid;grid-template-columns:repeat(2, minmax(0, 1fr));gap:2rem}@media (min-width: 640px){.docs-footer__columns{grid-template-columns:repeat(3, minmax(0, 1fr))}}.docs-footer__col{display:flex;flex-direction:column;gap:0.5rem}.docs-footer__col-header{margin:0 0 0.5rem;font-size:0.8125rem;font-weight:700!important;color:rgb(24 24 27)}html.dark .docs-footer__col-header{color:rgb(244 244 245)}.docs-footer__col a{font-size:0.8125rem;color:rgb(63 63 70);text-decoration:none;transition:color 0.15s ease}.docs-footer__col a:hover{color:rgb(24 24 27)}html.dark .docs-footer__col a{color:rgb(212 212 216)}html.dark .docs-footer__col a:hover{color:rgb(244 244 245)}.docs-footer__bottom{display:flex;flex-direction:column;align-items:flex-start;gap:0.75rem;padding-top:1.25rem}@media (min-width: 640px){.docs-footer__bottom{flex-direction:row;align-items:center;justify-content:space-between}}.docs-footer__copy{font-size:0.75rem;color:rgb(82 82 91)}html.dark .docs-footer__copy{color:rgb(161 161 170)}.docs-footer__status{display:inline-flex;align-items:center;gap:0.5rem;font-size:0.6875rem;font-weight:600;letter-spacing:0.1em;text-transform:uppercase;color:rgb(82 82 91);text-decoration:none;transition:color 0.15s ease}.docs-footer__status:hover{color:rgb(24 24 27)}html.dark .docs-footer__status{color:rgb(161 161 170)}html.dark .docs-footer__status:hover{color:rgb(244 244 245)}.docs-footer__status-dot{display:inline-block;flex-shrink:0;width:0.5rem;height:0.5rem;background-color:#10b981;border-radius:var(--radius-full);box-shadow:0 0 0 0 rgba(16, 185, 129, 0.55);animation:docs-footer-status-pulse 2.4s ease-in-out infinite}@keyframes docs-footer-status-pulse{0%,100%{box-shadow:0 0 0 0 rgba(16, 185, 129, 0.55)}50%{box-shadow:0 0 0 5px rgba(16, 185, 129, 0)}}@media (prefers-reduced-motion: reduce){.docs-footer__status-dot{animation:none;box-shadow:0 0 0 3px rgba(16, 185, 129, 0.25)}}#pagination{margin-top:3rem;padding-top:2rem;border-top:1px solid rgba(228, 228, 231, 0.8)}html.dark #pagination{border-top-color:rgba(63, 63, 70, 0.6)}#table-of-contents-layout{flex-direction:column}#table-of-contents-layout .feedback-toolbar{width:100%;margin-top:1.5rem;padding-top:1.5rem;padding-bottom:0;border-top:1px solid rgba(228, 228, 231, 0.8)}html.dark #table-of-contents-layout .feedback-toolbar{border-top-color:rgba(63, 63, 70, 0.6)}#table-of-contents-layout .feedback-toolbar>div{flex-direction:column;align-items:flex-start;gap:0.75rem}#table-of-contents-layout .feedback-toolbar p{white-space:normal}"}]}
{"page":{"pagePath":"api-reference/chat-sessions/update_ai_suggestion","slug":"/api-reference/chat-sessions/update_ai_suggestion","pageMetadata":{"openapi":"patch /chat/sessions/{session_id}/ai-suggestions/{suggestion_id}","sidebarTitle":"Update AI suggestion","description":"Update an AI suggestion — Replaces the text of a draft reply the AI wrote for your team in assist mode. Nothing is sent to the contact.","keywords":["chat","sessions","ai suggestion","assist mode","draft reply","edit draft","chat api"],"title":"Update an AI suggestion","href":"/api-reference/chat-sessions/update_ai_suggestion"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Update an AI suggestion — Replaces the text of a draft reply the AI wrote for your team in assist mode. Nothing is sent to the contact.\"\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{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Replaces the text of an `,_jsx(_components.a,{href:`/inbox/ai-writing-tools#review-ai-suggestions-in-assist-mode`,children:`AI suggestion`}),`: the draft reply the AI writes in assist mode for a teammate to review. Nothing is sent to the contact. The teammate still reviews the draft and sends it.`]}),`\n`,_jsxs(_components.p,{children:[`Find the suggestion with `,_jsx(_components.a,{href:`/api-reference/chat-sessions/list_history`,children:`List chat session history`}),`: it is an event of type `,_jsx(_components.code,{children:`ai_suggestion`}),`, and its `,_jsx(_components.code,{children:`id`}),` is the `,_jsx(_components.code,{children:`suggestion_id`}),` here. Write `,_jsx(_components.code,{children:`text`}),` in the language the reply should reach the contact in.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"text\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"Your refund was issued on the 14th and should reach your card within 5 business days.\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`The response is the updated `,_jsx(_components.code,{children:`ai_suggestion`}),` event, in the same shape the history returns.`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Translated sessions:`}),` the translated copy your team reads is rebuilt from the new text. A teammate who still has the earlier version in the composer sends their reply as written; the contact never gets new text or images that teammate hasn’t seen.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Activity log:`}),` every edit is recorded with the API key, Companion user or mini-app that made it.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Connected helpdesks:`}),` a copy of the draft that was already posted to your helpdesk (for example as an internal note) keeps its original text.`]}),`\n`,_jsxs(_components.li,{children:[_jsxs(_components.strong,{children:[`Not found (`,_jsx(_components.code,{children:`404`}),`):`]}),` the id is not a live AI suggestion of the session in the path, or the draft or session was redacted. Replies already sent to the contact, internal notes and other events can’t be edited here.`]}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{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":{"codeStyling":"dark","config":{},"pageMetadata":{"openapi":"patch /chat/sessions/{session_id}/ai-suggestions/{suggestion_id}","sidebarTitle":"Update AI suggestion","description":"Update an AI suggestion — Replaces the text of a draft reply the AI wrote for your team in assist mode. Nothing is sent to the contact.","keywords":["chat","sessions","ai suggestion","assist mode","draft reply","edit draft","chat api"],"title":"Update an AI suggestion","href":"/api-reference/chat-sessions/update_ai_suggestion"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/openchat/671ce9e295bc0bed/docs-footer.js","/_mintlify/custom/openchat/f9d6fdd61fce48db/opencx-widget.js","/_mintlify/custom/openchat/b138b1492ac22a58/docs-feedback.js"],"openApiReferenceData":{"operation":{"operationId":"updateChatSessionAiSuggestion","summary":"Update an AI suggestion","description":"Update an AI suggestion — Replaces the text of a draft reply the AI wrote for your team in assist mode. Nothing is sent to the contact.","requestBody":"96554bba-59ed-4b98-a7fa-e7deb63a640b","parameters":["4f824395-38b6-4d1e-8bb9-c694569c3a35","4c96c12b-8559-489b-bcc0-7e2a4a700379"],"responses":{"200":"ccbe6f72-704c-4cca-bc41-a0fce1005664","500":"a2f90dcb-7733-4e42-b467-9dc1fece79ae"},"method":"patch","type":"path","servers":["9c5088c1-d77b-4f1c-8c0c-6c8cc697284f","8daf936d-2d48-4a96-b70f-6d1b87fd4556"],"security":["9fa9c1e3-e477-4179-bc32-847afc596dc8"],"path":"/chat/sessions/{session_id}/ai-suggestions/{suggestion_id}","baseUrlOptions":["http://localhost:8080","https://api.open.cx"],"title":"Update an AI suggestion","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"4f824395-38b6-4d1e-8bb9-c694569c3a35":{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","isRequired":true,"description":"The unique identifier of the chat session","uniqueKey":"","typeLabel":"string\u003cuuid>"},"in":"path","name":"session_id","required":true,"description":"The unique identifier of the chat session"},"4c96c12b-8559-489b-bcc0-7e2a4a700379":{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","isRequired":true,"description":"The `id` of the `ai_suggestion` event in the session history","uniqueKey":"","typeLabel":"string\u003cuuid>"},"in":"path","name":"suggestion_id","required":true,"description":"The `id` of the `ai_suggestion` event in the session history"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"#/components/schemas/UpdateAiSuggestionInputInput","type":"object","properties":{"text":{"type":"string","minLength":1,"description":"Replacement draft text, in the language the reply should reach the contact in","isRequired":true,"uniqueKey":"text","typeLabel":"string"}},"required":["text"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"text":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"ccbe6f72-704c-4cca-bc41-a0fce1005664":{"description":"Default Response","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"#/components/schemas/ChatHistoryOutput","type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"created_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"event":{"oneOf":[{"type":"object","required":["type","sender","content","attachments"],"properties":{"type":{"type":"string","const":"message","isRequired":true,"uniqueKey":"event.oneOf.0.type","typeLabel":"string"},"sender":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"contact","isRequired":true,"uniqueKey":"event.oneOf.0.sender.oneOf.0.type","typeLabel":"string"},"name":{"type":"string","uniqueKey":"event.oneOf.0.sender.oneOf.0.name","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.0.sender.oneOf.0","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"ai","isRequired":true,"uniqueKey":"event.oneOf.0.sender.oneOf.1.type","typeLabel":"string"},"name":{"type":"string","uniqueKey":"event.oneOf.0.sender.oneOf.1.name","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.0.sender.oneOf.1","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"human_agent","isRequired":true,"uniqueKey":"event.oneOf.0.sender.oneOf.2.type","typeLabel":"string"},"name":{"type":"string","uniqueKey":"event.oneOf.0.sender.oneOf.2.name","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.0.sender.oneOf.2","typeLabel":"object"}],"isRequired":true,"uniqueKey":"event.oneOf.0.sender","typeLabel":"object"},"content":{"type":"object","properties":{"type":{"type":"string","const":"text","isRequired":true,"uniqueKey":"event.oneOf.0.content.type","typeLabel":"string"},"text":{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.0.content.text","typeLabel":"string"}},"required":["type","text"],"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.0.content","typeLabel":"object"},"attachments":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"#/components/schemas/PublicChatAttachment","type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.0.attachments.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.0.attachments.items.[INDEX].name","typeLabel":"string"},"size":{"type":"number","isRequired":true,"uniqueKey":"event.oneOf.0.attachments.items.[INDEX].size","typeLabel":"number"},"type":{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.0.attachments.items.[INDEX].type","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.0.attachments.items.[INDEX].url","typeLabel":"string"}},"required":["id","name","size","type","url"],"additionalProperties":false,"uniqueKey":"event.oneOf.0.attachments.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"event.oneOf.0.attachments","typeLabel":"object[]"},"email":{"description":"Per-message email headers. Omitted when no email metadata is stored. Does not include BCC recipients.","type":"object","properties":{"to":{"type":"array","items":{"type":"string","uniqueKey":"event.oneOf.0.email.to.items.[INDEX]","typeLabel":"string"},"description":"Visible To recipients recorded for this message.","isRequired":true,"uniqueKey":"event.oneOf.0.email.to","typeLabel":"string[]"},"cc":{"type":"array","items":{"type":"string","uniqueKey":"event.oneOf.0.email.cc.items.[INDEX]","typeLabel":"string"},"description":"Visible CC recipients recorded for this message.","isRequired":true,"uniqueKey":"event.oneOf.0.email.cc","typeLabel":"string[]"},"from":{"description":"Original sender address, when stored; may differ from the session contact when Reply-To is used.","type":"string","uniqueKey":"event.oneOf.0.email.from","typeLabel":"string"}},"required":["to","cc"],"additionalProperties":false,"uniqueKey":"event.oneOf.0.email","typeLabel":"object"},"context":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"event.oneOf.0.context.additionalProperties","typeLabel":"any"},"uniqueKey":"event.oneOf.0.context","typeLabel":"object"},"custom_data":{"description":"Custom data attached to this message by the sender (e.g. via the widget SDK)","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"event.oneOf.0.custom_data.additionalProperties","typeLabel":"any"},"uniqueKey":"event.oneOf.0.custom_data","typeLabel":"object"},"options":{"description":"Agent messages sent from a macro with options: the options the contact can tap. Report a tap with `message.option_reply` on Send a message.","type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"#/components/schemas/MessageOptionDto","type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.0.options.items.[INDEX].id","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.0.options.items.[INDEX].label","typeLabel":"string"},"type":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"#/components/schemas/MessageOptionType","type":"string","enum":["text","workflow"],"isRequired":true,"uniqueKey":"event.oneOf.0.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"required":["id","label","type"],"additionalProperties":false,"uniqueKey":"event.oneOf.0.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"event.oneOf.0.options","typeLabel":"object[]"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.0","typeLabel":"object"},{"type":"object","required":["type","internal","merge"],"properties":{"type":{"type":"string","const":"session_merged","isRequired":true,"uniqueKey":"event.oneOf.1.type","typeLabel":"string"},"internal":{"type":"boolean","const":true,"isRequired":true,"uniqueKey":"event.oneOf.1.internal","typeLabel":"boolean"},"merge":{"type":"object","properties":{"merge_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","isRequired":true,"uniqueKey":"event.oneOf.1.merge.merge_id","typeLabel":"string\u003cuuid>"},"source_session_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","isRequired":true,"uniqueKey":"event.oneOf.1.merge.source_session_id","typeLabel":"string\u003cuuid>"},"source_ticket_number":{"type":"number","isRequired":true,"uniqueKey":"event.oneOf.1.merge.source_ticket_number","typeLabel":"number"},"primary_session_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","isRequired":true,"uniqueKey":"event.oneOf.1.merge.primary_session_id","typeLabel":"string\u003cuuid>"},"primary_ticket_number":{"type":"number","isRequired":true,"uniqueKey":"event.oneOf.1.merge.primary_ticket_number","typeLabel":"number"},"actor":{"oneOf":[{"type":"object","required":["type","agentId"],"properties":{"type":{"type":"string","const":"agent","isRequired":true,"uniqueKey":"event.oneOf.1.merge.actor.oneOf.0.type","typeLabel":"string"},"agentId":{"type":"number","isRequired":true,"uniqueKey":"event.oneOf.1.merge.actor.oneOf.0.agentId","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.1.merge.actor.oneOf.0","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"api","isRequired":true,"uniqueKey":"event.oneOf.1.merge.actor.oneOf.1.type","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.1.merge.actor.oneOf.1","typeLabel":"object"},{"type":"object","required":["type","id","workflow_run_id"],"properties":{"type":{"type":"string","const":"workflow","isRequired":true,"uniqueKey":"event.oneOf.1.merge.actor.oneOf.2.type","typeLabel":"string"},"id":{"type":"string","description":"The workflow that performed the merge.","isRequired":true,"uniqueKey":"event.oneOf.1.merge.actor.oneOf.2.id","typeLabel":"string"},"workflow_run_id":{"type":"string","description":"The workflow run that performed the merge.","isRequired":true,"uniqueKey":"event.oneOf.1.merge.actor.oneOf.2.workflow_run_id","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.1.merge.actor.oneOf.2","typeLabel":"object"}],"isRequired":true,"uniqueKey":"event.oneOf.1.merge.actor","typeLabel":"object"},"redacted":{"type":"boolean","uniqueKey":"event.oneOf.1.merge.redacted","typeLabel":"boolean"}},"required":["merge_id","source_session_id","source_ticket_number","primary_session_id","primary_ticket_number","actor"],"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.1.merge","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.1","typeLabel":"object"},{"type":"object","required":["type","internal","source"],"properties":{"type":{"type":"string","const":"merged_session_message","isRequired":true,"uniqueKey":"event.oneOf.2.type","typeLabel":"string"},"internal":{"type":"boolean","const":true,"isRequired":true,"uniqueKey":"event.oneOf.2.internal","typeLabel":"boolean"},"source":{"type":"object","properties":{"merge_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","isRequired":true,"uniqueKey":"event.oneOf.2.source.merge_id","typeLabel":"string\u003cuuid>"},"source_session_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","isRequired":true,"uniqueKey":"event.oneOf.2.source.source_session_id","typeLabel":"string\u003cuuid>"},"source_ticket_number":{"type":"number","isRequired":true,"uniqueKey":"event.oneOf.2.source.source_ticket_number","typeLabel":"number"},"source_message_uuid":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","isRequired":true,"uniqueKey":"event.oneOf.2.source.source_message_uuid","typeLabel":"string\u003cuuid>"},"redacted":{"type":"boolean","uniqueKey":"event.oneOf.2.source.redacted","typeLabel":"boolean"}},"required":["merge_id","source_session_id","source_ticket_number","source_message_uuid"],"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.2.source","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.2","typeLabel":"object"},{"type":"object","required":["type","message_type","content"],"properties":{"type":{"type":"string","const":"unmapped_event","description":"A recorded event without a typed history mapping. Included in organization exports so no history rows are lost.","isRequired":true,"uniqueKey":"event.oneOf.3.type","typeLabel":"string"},"message_type":{"type":"string","enum":["agent_assigned_by_integration","agent_assigned_by_system","agent_assigned_by_user","agent_changed","agent_comment","agent_initiated_session","agent_joined","agent_message","agent_message_deleted_by_agent","agent_reopened_session","agent_took_session_from_ai","agent_unassigned_by_integration","agent_unassigned_by_system","agent_unassigned_by_user","ai_assumed_the_session_resolved","ai_decided_to_not_reply","ai_decided_to_resolve_the_issue","ai_follow_up_cancelled","ai_follow_up_fired","ai_follow_up_scheduled","ai_reopened_session","ai_response_cancelled","ai_resumed_by_system","ai_services_paused_handoff","ai_suggestion","call_history","call_transferred","ces_request_cancelled","ces_requested","ces_submitted","closed_resolved_by_agent","closed_resolved_by_api","closed_resolved_by_contact","closed_resolved_by_integration","closed_resolved_by_system","closed_unresolved_by_agent","closed_unresolved_by_api","closed_unresolved_by_system","contact_data_updated","csat_request_cancelled","csat_requested","csat_submitted","email_draft_message","handoff","handoff_to_salesforce_miaw","handoff_to_third_party_failed","handoff_to_zendesk","integration_reopened_session","ivr_selection","journey_step_by_integration","merged_session_message","message","nps_request_cancelled","nps_requested","nps_submitted","pii_attachment_removed","primary_contact_changed","prohibited_topic_detected","quoted_content_modified","salesforce_fields_updated","sequence_message","session_erased_by_system_due_to_retention_threshold","session_forwarded","session_language_changed_by_agent","session_language_changed_by_api","session_language_changed_by_integration","session_language_changed_by_system","session_merged","session_priority_changed_by_agent","session_priority_changed_by_system","session_snoozed","session_subject_changed_by_agent","session_subject_changed_by_system","session_unsnoozed","skills_added_by_system","sla_applied_by_agent","sla_applied_by_system","sla_first_reply_breached","sla_first_reply_completed_after_breach","sla_first_reply_fulfilled","sla_first_reply_metric_started","sla_freezed_office_hours_ended","sla_freezed_snoozed","sla_next_reply_breached","sla_next_reply_completed_after_breach","sla_next_reply_fulfilled","sla_next_reply_metric_started","sla_removed_by_agent","sla_removed_by_system","sla_resolution_breached","sla_resolution_completed_after_breach","sla_resolution_fulfilled","sla_resolution_metric_started","sla_resolution_paused_resolved","sla_resolution_paused_waiting_on_customer","sla_resolution_resumed_customer_replied","sla_resolution_resumed_reopened","sla_resumed_office_hours_started","sla_resumed_snooze_cancelled","sla_resumed_snooze_expired","state_checkpoint","sub_session_created","sub_session_linked_by_agent","sub_session_linked_by_api","sub_session_linked_by_integration","sub_session_linked_by_system","sub_session_unlinked_by_agent","sub_session_unlinked_by_api","sub_session_unlinked_by_integration","sub_session_unlinked_by_system","sub_status_removed_by_agent","sub_status_removed_by_api","sub_status_removed_by_integration","sub_status_removed_by_system","sub_status_set_by_agent","sub_status_set_by_api","sub_status_set_by_integration","sub_status_set_by_system","system_reopened_session","tag_added_by_agent","tag_added_by_api","tag_added_by_integration","tag_added_by_system","tag_removed_by_agent","tag_removed_by_api","tag_removed_by_integration","tag_removed_by_system","team_assigned_by_integration","team_assigned_by_system","team_assigned_by_user","team_unassigned_by_integration","team_unassigned_by_system","team_unassigned_by_user","user_confirmed_the_session_resolved","voice_call_ai_joined","voice_call_ai_left","voice_call_contact_answered","voice_call_contact_joined","voice_call_contact_left","voice_call_ended","voice_call_failed_to_start","voice_call_human_answered","voice_call_human_joined","voice_call_human_left","voice_call_started","workflow_message","workflow_note","workflow_triggered"],"isRequired":true,"uniqueKey":"event.oneOf.3.message_type","typeLabel":"enum\u003cstring>"},"content":{"oneOf":[{"type":"object","required":["type","text"],"properties":{"type":{"type":"string","const":"text","isRequired":true,"uniqueKey":"event.oneOf.3.content.oneOf.0.type","typeLabel":"string"},"text":{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.3.content.oneOf.0.text","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.3.content.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"event.oneOf.3.content.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"event.oneOf.3.content","typeLabel":"object | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.3","typeLabel":"object"},{"type":"object","required":["type","content","comment_thread_id"],"properties":{"type":{"type":"string","const":"ai_comment","description":"An internal note authored by AI.","isRequired":true,"uniqueKey":"event.oneOf.4.type","typeLabel":"string"},"content":{"type":"object","properties":{"type":{"type":"string","const":"text","isRequired":true,"uniqueKey":"event.oneOf.4.content.type","typeLabel":"string"},"text":{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.4.content.text","typeLabel":"string"}},"required":["type","text"],"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.4.content","typeLabel":"object"},"comment_thread_id":{"oneOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","isRequired":true,"uniqueKey":"event.oneOf.4.comment_thread_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","isRequired":true,"uniqueKey":"event.oneOf.4.comment_thread_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"event.oneOf.4.comment_thread_id","typeLabel":"string\u003cuuid> | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.4","typeLabel":"object"},{"type":"object","required":["type","content","attachments"],"properties":{"type":{"type":"string","const":"ai_suggestion","description":"An AI draft reply produced in assist mode — suggested to the human support team, never delivered to the contact.","isRequired":true,"uniqueKey":"event.oneOf.5.type","typeLabel":"string"},"content":{"type":"object","properties":{"type":{"type":"string","const":"text","isRequired":true,"uniqueKey":"event.oneOf.5.content.type","typeLabel":"string"},"text":{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.5.content.text","typeLabel":"string"}},"required":["type","text"],"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.5.content","typeLabel":"object"},"attachments":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"#/components/schemas/PublicChatAttachment","type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.5.attachments.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.5.attachments.items.[INDEX].name","typeLabel":"string"},"size":{"type":"number","isRequired":true,"uniqueKey":"event.oneOf.5.attachments.items.[INDEX].size","typeLabel":"number"},"type":{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.5.attachments.items.[INDEX].type","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.5.attachments.items.[INDEX].url","typeLabel":"string"}},"required":["id","name","size","type","url"],"additionalProperties":false,"uniqueKey":"event.oneOf.5.attachments.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"event.oneOf.5.attachments","typeLabel":"object[]"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.5","typeLabel":"object"},{"type":"object","required":["type","workflow_id","workflow_run_id","content"],"properties":{"type":{"type":"string","const":"workflow_message","isRequired":true,"uniqueKey":"event.oneOf.6.type","typeLabel":"string"},"workflow_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.6.workflow_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"event.oneOf.6.workflow_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"event.oneOf.6.workflow_id","typeLabel":"string | null"},"workflow_run_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.6.workflow_run_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"event.oneOf.6.workflow_run_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"event.oneOf.6.workflow_run_id","typeLabel":"string | null"},"content":{"type":"object","properties":{"type":{"type":"string","const":"text","isRequired":true,"uniqueKey":"event.oneOf.6.content.type","typeLabel":"string"},"text":{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.6.content.text","typeLabel":"string"}},"required":["type","text"],"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.6.content","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.6","typeLabel":"object"},{"type":"object","required":["type","sequence_id","content"],"properties":{"type":{"type":"string","const":"sequence_message","isRequired":true,"uniqueKey":"event.oneOf.7.type","typeLabel":"string"},"sequence_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.7.sequence_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"event.oneOf.7.sequence_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"event.oneOf.7.sequence_id","typeLabel":"string | null"},"content":{"type":"object","properties":{"type":{"type":"string","const":"text","isRequired":true,"uniqueKey":"event.oneOf.7.content.type","typeLabel":"string"},"text":{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.7.content.text","typeLabel":"string"}},"required":["type","text"],"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.7.content","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.7","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"handoff","isRequired":true,"uniqueKey":"event.oneOf.8.type","typeLabel":"string"},"integration":{"type":"object","properties":{"type":{"type":"string","enum":["zendesk","salesforce-miaw"],"isRequired":true,"uniqueKey":"event.oneOf.8.integration.type","typeLabel":"enum\u003cstring>"}},"required":["type"],"additionalProperties":false,"uniqueKey":"event.oneOf.8.integration","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.8","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"closed_resolved_by_agent","isRequired":true,"uniqueKey":"event.oneOf.9.type","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.9","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"closed_resolved_by_system","isRequired":true,"uniqueKey":"event.oneOf.10.type","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.10","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"closed_resolved_by_api","isRequired":true,"uniqueKey":"event.oneOf.11.type","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.11","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"closed_unresolved_by_agent","isRequired":true,"uniqueKey":"event.oneOf.12.type","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.12","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"closed_unresolved_by_system","isRequired":true,"uniqueKey":"event.oneOf.13.type","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.13","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"closed_unresolved_by_api","isRequired":true,"uniqueKey":"event.oneOf.14.type","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.14","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"closed_resolved_by_contact","isRequired":true,"uniqueKey":"event.oneOf.15.type","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.15","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"closed_resolved_by_integration","isRequired":true,"uniqueKey":"event.oneOf.16.type","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.16","typeLabel":"object"},{"type":"object","required":["type","sub_status_id"],"properties":{"type":{"type":"string","const":"sub_status_set_by_agent","isRequired":true,"uniqueKey":"event.oneOf.17.type","typeLabel":"string"},"sub_status_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.17.sub_status_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"event.oneOf.17.sub_status_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"event.oneOf.17.sub_status_id","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.17","typeLabel":"object"},{"type":"object","required":["type","sub_status_id"],"properties":{"type":{"type":"string","const":"sub_status_set_by_system","isRequired":true,"uniqueKey":"event.oneOf.18.type","typeLabel":"string"},"sub_status_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.18.sub_status_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"event.oneOf.18.sub_status_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"event.oneOf.18.sub_status_id","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.18","typeLabel":"object"},{"type":"object","required":["type","sub_status_id"],"properties":{"type":{"type":"string","const":"sub_status_set_by_api","isRequired":true,"uniqueKey":"event.oneOf.19.type","typeLabel":"string"},"sub_status_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.19.sub_status_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"event.oneOf.19.sub_status_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"event.oneOf.19.sub_status_id","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.19","typeLabel":"object"},{"type":"object","required":["type","sub_status_id"],"properties":{"type":{"type":"string","const":"sub_status_removed_by_agent","isRequired":true,"uniqueKey":"event.oneOf.20.type","typeLabel":"string"},"sub_status_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.20.sub_status_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"event.oneOf.20.sub_status_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"event.oneOf.20.sub_status_id","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.20","typeLabel":"object"},{"type":"object","required":["type","sub_status_id"],"properties":{"type":{"type":"string","const":"sub_status_removed_by_system","isRequired":true,"uniqueKey":"event.oneOf.21.type","typeLabel":"string"},"sub_status_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.21.sub_status_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"event.oneOf.21.sub_status_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"event.oneOf.21.sub_status_id","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.21","typeLabel":"object"},{"type":"object","required":["type","sub_status_id"],"properties":{"type":{"type":"string","const":"sub_status_removed_by_api","isRequired":true,"uniqueKey":"event.oneOf.22.type","typeLabel":"string"},"sub_status_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.22.sub_status_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"event.oneOf.22.sub_status_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"event.oneOf.22.sub_status_id","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.22","typeLabel":"object"},{"type":"object","required":["type","sub_status_id"],"properties":{"type":{"type":"string","const":"sub_status_set_by_integration","isRequired":true,"uniqueKey":"event.oneOf.23.type","typeLabel":"string"},"sub_status_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.23.sub_status_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"event.oneOf.23.sub_status_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"event.oneOf.23.sub_status_id","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.23","typeLabel":"object"},{"type":"object","required":["type","sub_status_id"],"properties":{"type":{"type":"string","const":"sub_status_removed_by_integration","isRequired":true,"uniqueKey":"event.oneOf.24.type","typeLabel":"string"},"sub_status_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.24.sub_status_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"event.oneOf.24.sub_status_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"event.oneOf.24.sub_status_id","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.24","typeLabel":"object"},{"type":"object","required":["type","tags"],"properties":{"type":{"type":"string","enum":["tag_added_by_system","tag_added_by_agent","tag_added_by_api","tag_added_by_integration","tag_removed_by_system","tag_removed_by_agent","tag_removed_by_api","tag_removed_by_integration"],"isRequired":true,"uniqueKey":"event.oneOf.25.type","typeLabel":"enum\u003cstring>"},"tags":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.25.tags.items.[INDEX].name","typeLabel":"string"}},"required":["name"],"additionalProperties":false,"uniqueKey":"event.oneOf.25.tags.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"event.oneOf.25.tags","typeLabel":"object[]"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.25","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"ai_resolved_issue","isRequired":true,"uniqueKey":"event.oneOf.26.type","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.26","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"ai_assumed_issue_resolved","isRequired":true,"uniqueKey":"event.oneOf.27.type","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.27","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"user_confirmed_issue_resolved","isRequired":true,"uniqueKey":"event.oneOf.28.type","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.28","typeLabel":"object"},{"type":"object","required":["type","human_agent_id","content","comment_thread_id"],"properties":{"type":{"type":"string","const":"human_agent_comment","isRequired":true,"uniqueKey":"event.oneOf.29.type","typeLabel":"string"},"human_agent_id":{"type":"number","isRequired":true,"uniqueKey":"event.oneOf.29.human_agent_id","typeLabel":"number"},"content":{"type":"object","properties":{"type":{"type":"string","const":"text","isRequired":true,"uniqueKey":"event.oneOf.29.content.type","typeLabel":"string"},"text":{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.29.content.text","typeLabel":"string"}},"required":["type","text"],"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.29.content","typeLabel":"object"},"comment_thread_id":{"oneOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","isRequired":true,"uniqueKey":"event.oneOf.29.comment_thread_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","isRequired":true,"uniqueKey":"event.oneOf.29.comment_thread_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"event.oneOf.29.comment_thread_id","typeLabel":"string\u003cuuid> | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.29","typeLabel":"object"},{"type":"object","required":["type","workflow_id","workflow_run_id","content"],"properties":{"type":{"type":"string","const":"workflow_note","isRequired":true,"uniqueKey":"event.oneOf.30.type","typeLabel":"string"},"workflow_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.30.workflow_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"event.oneOf.30.workflow_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"event.oneOf.30.workflow_id","typeLabel":"string | null"},"workflow_run_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.30.workflow_run_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"event.oneOf.30.workflow_run_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"event.oneOf.30.workflow_run_id","typeLabel":"string | null"},"content":{"type":"object","properties":{"type":{"type":"string","const":"text","isRequired":true,"uniqueKey":"event.oneOf.30.content.type","typeLabel":"string"},"text":{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.30.content.text","typeLabel":"string"}},"required":["type","text"],"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.30.content","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.30","typeLabel":"object"},{"type":"object","required":["type","human_agent_id"],"properties":{"type":{"type":"string","const":"human_agent_joined","isRequired":true,"uniqueKey":"event.oneOf.31.type","typeLabel":"string"},"human_agent_id":{"type":"number","isRequired":true,"uniqueKey":"event.oneOf.31.human_agent_id","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.31","typeLabel":"object"},{"type":"object","required":["type","human_agent_id"],"properties":{"type":{"type":"string","const":"human_agent_takeover","isRequired":true,"uniqueKey":"event.oneOf.32.type","typeLabel":"string"},"human_agent_id":{"type":"number","isRequired":true,"uniqueKey":"event.oneOf.32.human_agent_id","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.32","typeLabel":"object"},{"type":"object","required":["type","human_agent_id"],"properties":{"type":{"type":"string","const":"human_agent_reopened_session","isRequired":true,"uniqueKey":"event.oneOf.33.type","typeLabel":"string"},"human_agent_id":{"type":"number","isRequired":true,"uniqueKey":"event.oneOf.33.human_agent_id","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.33","typeLabel":"object"},{"type":"object","required":["type","workflow_id","workflow_run_id"],"properties":{"type":{"type":"string","const":"system_reopened_session","isRequired":true,"uniqueKey":"event.oneOf.34.type","typeLabel":"string"},"workflow_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.34.workflow_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"event.oneOf.34.workflow_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"event.oneOf.34.workflow_id","typeLabel":"string | null"},"workflow_run_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.34.workflow_run_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"event.oneOf.34.workflow_run_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"event.oneOf.34.workflow_run_id","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.34","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"integration_reopened_session","isRequired":true,"uniqueKey":"event.oneOf.35.type","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.35","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"ai_reopened_session","isRequired":true,"uniqueKey":"event.oneOf.36.type","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.36","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"session_erased_by_system_due_to_retention_threshold","description":"The session's content was erased because it passed the organization's retention threshold.","isRequired":true,"uniqueKey":"event.oneOf.37.type","typeLabel":"string"},"reason":{"description":"Which retention rule erased the session, as a sentence such as \"Closed for 30 days\" or \"No activity for 90 days\".","type":"string","uniqueKey":"event.oneOf.37.reason","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.37","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"state_checkpoint","isRequired":true,"uniqueKey":"event.oneOf.38.type","typeLabel":"string"},"payload":{"oneOf":[{}],"uniqueKey":"event.oneOf.38.payload","typeLabel":"any"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.38","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"csat_requested","isRequired":true,"uniqueKey":"event.oneOf.39.type","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.39","typeLabel":"object"},{"type":"object","required":["type","payload"],"properties":{"type":{"type":"string","const":"csat_submitted","isRequired":true,"uniqueKey":"event.oneOf.40.type","typeLabel":"string"},"payload":{"type":"object","properties":{"score":{"type":"number","isRequired":true,"uniqueKey":"event.oneOf.40.payload.score","typeLabel":"number"},"feedback":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.40.payload.feedback.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"event.oneOf.40.payload.feedback.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"event.oneOf.40.payload.feedback","typeLabel":"string | null"}},"required":["score","feedback"],"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.40.payload","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.40","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"nps_requested","isRequired":true,"uniqueKey":"event.oneOf.41.type","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.41","typeLabel":"object"},{"type":"object","required":["type","payload"],"properties":{"type":{"type":"string","const":"nps_submitted","isRequired":true,"uniqueKey":"event.oneOf.42.type","typeLabel":"string"},"payload":{"type":"object","properties":{"score":{"type":"number","isRequired":true,"uniqueKey":"event.oneOf.42.payload.score","typeLabel":"number"},"feedback":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.42.payload.feedback.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"event.oneOf.42.payload.feedback.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"event.oneOf.42.payload.feedback","typeLabel":"string | null"}},"required":["score","feedback"],"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.42.payload","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.42","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"ces_requested","isRequired":true,"uniqueKey":"event.oneOf.43.type","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.43","typeLabel":"object"},{"type":"object","required":["type","payload"],"properties":{"type":{"type":"string","const":"ces_submitted","isRequired":true,"uniqueKey":"event.oneOf.44.type","typeLabel":"string"},"payload":{"type":"object","properties":{"score":{"type":"number","isRequired":true,"uniqueKey":"event.oneOf.44.payload.score","typeLabel":"number"},"feedback":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.44.payload.feedback.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"event.oneOf.44.payload.feedback.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"event.oneOf.44.payload.feedback","typeLabel":"string | null"}},"required":["score","feedback"],"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.44.payload","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.44","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"agent_changed","isRequired":true,"uniqueKey":"event.oneOf.45.type","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.45","typeLabel":"object"},{"type":"object","required":["type","topic"],"properties":{"type":{"type":"string","const":"prohibited_topic_detected","isRequired":true,"uniqueKey":"event.oneOf.46.type","typeLabel":"string"},"topic":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.46.topic.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"event.oneOf.46.topic.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"event.oneOf.46.topic","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.46","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"ai_services_paused","isRequired":true,"uniqueKey":"event.oneOf.47.type","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.47","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"agent_assigned_by_system","isRequired":true,"uniqueKey":"event.oneOf.48.type","typeLabel":"string"},"assigned_agent_id":{"type":"number","uniqueKey":"event.oneOf.48.assigned_agent_id","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.48","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"agent_assigned_by_integration","isRequired":true,"uniqueKey":"event.oneOf.49.type","typeLabel":"string"},"assigned_agent_id":{"type":"number","uniqueKey":"event.oneOf.49.assigned_agent_id","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.49","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"agent_assigned_by_user","isRequired":true,"uniqueKey":"event.oneOf.50.type","typeLabel":"string"},"assigned_agent_id":{"type":"number","uniqueKey":"event.oneOf.50.assigned_agent_id","typeLabel":"number"},"actor_id":{"type":"number","uniqueKey":"event.oneOf.50.actor_id","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.50","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"agent_unassigned_by_system","isRequired":true,"uniqueKey":"event.oneOf.51.type","typeLabel":"string"},"unassigned_agent_id":{"type":"number","uniqueKey":"event.oneOf.51.unassigned_agent_id","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.51","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"agent_unassigned_by_integration","isRequired":true,"uniqueKey":"event.oneOf.52.type","typeLabel":"string"},"unassigned_agent_id":{"type":"number","uniqueKey":"event.oneOf.52.unassigned_agent_id","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.52","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"agent_unassigned_by_user","isRequired":true,"uniqueKey":"event.oneOf.53.type","typeLabel":"string"},"unassigned_agent_id":{"type":"number","uniqueKey":"event.oneOf.53.unassigned_agent_id","typeLabel":"number"},"actor_id":{"type":"number","uniqueKey":"event.oneOf.53.actor_id","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.53","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"team_assigned_by_system","isRequired":true,"uniqueKey":"event.oneOf.54.type","typeLabel":"string"},"assigned_team_id":{"type":"string","uniqueKey":"event.oneOf.54.assigned_team_id","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.54","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"team_assigned_by_integration","isRequired":true,"uniqueKey":"event.oneOf.55.type","typeLabel":"string"},"assigned_team_id":{"type":"string","uniqueKey":"event.oneOf.55.assigned_team_id","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.55","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"team_assigned_by_user","isRequired":true,"uniqueKey":"event.oneOf.56.type","typeLabel":"string"},"assigned_team_id":{"type":"string","uniqueKey":"event.oneOf.56.assigned_team_id","typeLabel":"string"},"actor_id":{"type":"number","uniqueKey":"event.oneOf.56.actor_id","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.56","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"team_unassigned_by_system","isRequired":true,"uniqueKey":"event.oneOf.57.type","typeLabel":"string"},"unassigned_team_id":{"type":"string","uniqueKey":"event.oneOf.57.unassigned_team_id","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.57","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"team_unassigned_by_integration","isRequired":true,"uniqueKey":"event.oneOf.58.type","typeLabel":"string"},"unassigned_team_id":{"type":"string","uniqueKey":"event.oneOf.58.unassigned_team_id","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.58","typeLabel":"object"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","const":"team_unassigned_by_user","isRequired":true,"uniqueKey":"event.oneOf.59.type","typeLabel":"string"},"unassigned_team_id":{"type":"string","uniqueKey":"event.oneOf.59.unassigned_team_id","typeLabel":"string"},"actor_id":{"type":"number","uniqueKey":"event.oneOf.59.actor_id","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.59","typeLabel":"object"},{"type":"object","required":["type","elapsed_ms"],"properties":{"type":{"type":"string","enum":["sla_applied_by_system","sla_applied_by_agent","sla_removed_by_agent","sla_removed_by_system","sla_first_reply_metric_started","sla_first_reply_fulfilled","sla_first_reply_breached","sla_first_reply_completed_after_breach","sla_next_reply_metric_started","sla_next_reply_fulfilled","sla_next_reply_breached","sla_next_reply_completed_after_breach","sla_resolution_metric_started","sla_resolution_paused_waiting_on_customer","sla_resolution_paused_resolved","sla_resolution_resumed_customer_replied","sla_resolution_resumed_reopened","sla_resolution_fulfilled","sla_resolution_breached","sla_resolution_completed_after_breach","sla_freezed_office_hours_ended","sla_resumed_office_hours_started","sla_freezed_snoozed","sla_resumed_snooze_expired","sla_resumed_snooze_cancelled"],"isRequired":true,"uniqueKey":"event.oneOf.60.type","typeLabel":"enum\u003cstring>"},"elapsed_ms":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"event.oneOf.60.elapsed_ms.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"event.oneOf.60.elapsed_ms.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"event.oneOf.60.elapsed_ms","typeLabel":"number | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.60","typeLabel":"object"},{"type":"object","required":["type","workflow_id","workflow_run_id"],"properties":{"type":{"type":"string","const":"workflow_triggered","isRequired":true,"uniqueKey":"event.oneOf.61.type","typeLabel":"string"},"workflow_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.61.workflow_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"event.oneOf.61.workflow_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"event.oneOf.61.workflow_id","typeLabel":"string | null"},"workflow_run_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"event.oneOf.61.workflow_run_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"event.oneOf.61.workflow_run_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"event.oneOf.61.workflow_run_id","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.61","typeLabel":"object"},{"type":"object","required":["type","fields"],"properties":{"type":{"type":"string","const":"contact_data_updated","isRequired":true,"uniqueKey":"event.oneOf.62.type","typeLabel":"string"},"fields":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string","uniqueKey":"event.oneOf.62.fields.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"event.oneOf.62.fields","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"event.oneOf.62","typeLabel":"object"}],"isRequired":true,"uniqueKey":"event","typeLabel":"object"}},"required":["id","created_at","event"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","created_at":"2023-11-07T05:31:56Z","event":{"type":"message","sender":{"type":"contact","name":"\u003cstring>"},"content":{"type":"text","text":"\u003cstring>"},"attachments":[{"id":"\u003cstring>","name":"\u003cstring>","size":123,"type":"\u003cstring>","url":"\u003cstring>"}],"email":{"to":["\u003cstring>"],"cc":["\u003cstring>"],"from":"\u003cstring>"},"context":{},"custom_data":{},"options":[{"id":"\u003cstring>","label":"\u003cstring>","type":"text"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"a2f90dcb-7733-4e42-b467-9dc1fece79ae":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","uniqueKey":"statusCode","typeLabel":"integer"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":123,"message":"\u003cstring>","error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"9fa9c1e3-e477-4179-bc32-847afc596dc8":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"9c5088c1-d77b-4f1c-8c0c-6c8cc697284f":{"url":"http://localhost:8080","description":"Development"},"8daf936d-2d48-4a96-b70f-6d1b87fd4556":{"url":"https://api.open.cx","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"https://api.open.cx/api-json"},"subdomain":"openchat","siteName":"OpenCX Docs","title":"Update an AI suggestion - OpenCX Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-20T19:50:50.342Z","originalFileLocation":"api-reference/chat-sessions/update_ai_suggestion.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=\"dark\"}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=\"Update an AI suggestion — Replaces the text of a draft reply the AI wrote for your team in assist mode. Nothing is sent to the contact.\">\u003cmeta data-mint-head name=\"application-name\" content=\"OpenCX Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/openchat/RMvbDkK3gsg3p3OQ/_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/openchat/RMvbDkK3gsg3p3OQ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/openchat/RMvbDkK3gsg3p3OQ/_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/openchat/RMvbDkK3gsg3p3OQ/_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/openchat/RMvbDkK3gsg3p3OQ/_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/openchat/RMvbDkK3gsg3p3OQ/_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/openchat/RMvbDkK3gsg3p3OQ/_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/openchat/RMvbDkK3gsg3p3OQ/_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/openchat/RMvbDkK3gsg3p3OQ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update an AI suggestion - OpenCX Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update an AI suggestion — Replaces the text of a draft reply the AI wrote for your team in assist mode. Nothing is sent to the contact.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OpenCX Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.open.cx/api-reference/chat-sessions/update_ai_suggestion\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://openchat.mintlify.site/_mintlify/api/og/v2?division=Sessions\u0026amp;title=Update+an+AI+suggestion\u0026amp;description=Update+an+AI+suggestion+%E2%80%94+Replaces+the+text+of+a+draft+reply+the+AI+wrote+for+your+team+in+assist+mode.+Nothing+is+sent+to+the+contact.\u0026amp;theme=72d72b73315e45575f2de3ec\u0026amp;signature=4b5b8b65df47d1a695a70d7082296a9ddbdfeff3817bc3c2f361d81a9e61882f\">\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 an AI suggestion - OpenCX Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update an AI suggestion — Replaces the text of a draft reply the AI wrote for your team in assist mode. Nothing is sent to the contact.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://openchat.mintlify.site/_mintlify/api/og/v2?division=Sessions\u0026amp;title=Update+an+AI+suggestion\u0026amp;description=Update+an+AI+suggestion+%E2%80%94+Replaces+the+text+of+a+draft+reply+the+AI+wrote+for+your+team+in+assist+mode.+Nothing+is+sent+to+the+contact.\u0026amp;theme=72d72b73315e45575f2de3ec\u0026amp;signature=4b5b8b65df47d1a695a70d7082296a9ddbdfeff3817bc3c2f361d81a9e61882f\">\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/openchat/RMvbDkK3gsg3p3OQ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"OpenCX Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0A0A0A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.open.cx/api-reference/chat-sessions/update_ai_suggestion\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/chat-sessions/update_ai_suggestion.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.open.cx/#organization\",\"name\":\"OpenCX Docs\",\"url\":\"https://docs.open.cx\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/openchat/ivWwffb57vEmukK4/logo-light.svg?fit=max\u0026auto=format\u0026n=ivWwffb57vEmukK4\u0026q=85\u0026s=f6a5e94f4909a4d8df45757989c11afe\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.open.cx#website\",\"name\":\"OpenCX Docs\",\"url\":\"https://docs.open.cx\",\"publisher\":{\"@id\":\"https://docs.open.cx/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.open.cx/api-reference/chat-sessions/update_ai_suggestion#webpage\",\"url\":\"https://docs.open.cx/api-reference/chat-sessions/update_ai_suggestion\",\"name\":\"Update an AI suggestion\",\"description\":\"Update an AI suggestion — Replaces the text of a draft reply the AI wrote for your team in assist mode. Nothing is sent to the contact.\",\"dateModified\":\"2026-11-20T19:50:50.342Z\",\"isPartOf\":{\"@id\":\"https://docs.open.cx#website\"},\"breadcrumb\":{\"@id\":\"https://docs.open.cx/api-reference/chat-sessions/update_ai_suggestion#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.open.cx/api-reference/chat-sessions/update_ai_suggestion#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Sessions and inbox\",\"item\":\"https://docs.open.cx/api-reference/chat-sessions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Sessions\",\"item\":\"https://docs.open.cx/api-reference/chat-sessions\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update an AI suggestion\",\"item\":\"https://docs.open.cx/api-reference/chat-sessions/update_ai_suggestion\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.open.cx/api-reference/chat-sessions/update_ai_suggestion#apireference\",\"headline\":\"Update an AI suggestion\",\"name\":\"Update an AI suggestion\",\"description\":\"Update an AI suggestion — Replaces the text of a draft reply the AI wrote for your team in assist mode. Nothing is sent to the contact.\",\"url\":\"https://docs.open.cx/api-reference/chat-sessions/update_ai_suggestion\",\"mainEntityOfPage\":{\"@id\":\"https://docs.open.cx/api-reference/chat-sessions/update_ai_suggestion#webpage\"},\"dateModified\":\"2026-11-20T19:50:50.342Z\",\"keywords\":\"chat, sessions, ai suggestion, assist mode, draft reply, edit draft, chat api\",\"publisher\":{\"@id\":\"https://docs.open.cx/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.open.cx#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"OpenCX Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"OpenCX Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/chat-sessions/update_ai_suggestion.md","siteName":"OpenCX Docs","nav":{"global":null,"tabs":[{"tab":"Get Started","icon":"book-open","pages":[{"title":"Get Started","href":"/welcome"}]},{"tab":"Build Agents","icon":"robot","pages":[{"title":"Build Agents","href":"/build-agents/get-started"}]},{"tab":"Agent Training","icon":"book","pages":[{"title":"Agent Training","href":"/knowledge/introduction"}]},{"tab":"Ticketing","icon":"ticket","pages":[{"title":"Ticketing","href":"/ticketing/overview"}]},{"tab":"Automate","icon":"bolt","pages":[{"title":"Automate","href":"/companion/introduction"}]},{"tab":"Integrations","icon":"plug","pages":[{"title":"Integrations","href":"/dashboard/introduction"}]},{"tab":"Trust \u0026 Safety","icon":"shield","pages":[{"title":"Trust \u0026 Safety","href":"/safety/introduction"}]},{"tab":"Developers","icon":"code","pages":[{"title":"Developers","href":"/mcp/introduction"}]},{"tab":"Partners","icon":"handshake","pages":[{"title":"Partners","href":"/partners/introduction"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Overview","pages":[{"title":"Authentication","icon":"key","href":"/api-reference/authentication"}]},{"group":"Sessions and inbox","pages":[{"group":"Sessions","pages":[{"title":"Sessions","icon":"list","href":"/api-reference/chat-sessions/index"},{"openapi":"post /chat/sessions","sidebarTitle":"Create","title":"Create a chat session","href":"/api-reference/chat-sessions/create"},{"openapi":"post /chat/sessions/{session_id}/merge","sidebarTitle":"Merge sessions","title":"Merge sessions","href":"/api-reference/chat-sessions/merge"},{"openapi":"get /chat/sessions/{session_id}","sidebarTitle":"Get","title":"Get a chat session","href":"/api-reference/chat-sessions/get"},{"openapi":"get /chat/sessions","sidebarTitle":"List","title":"List chat sessions","href":"/api-reference/chat-sessions/list"},{"openapi":"post /chat/sessions/filter","sidebarTitle":"Filter","title":"Filter chat sessions","href":"/api-reference/chat-sessions/filter"},{"openapi":"patch /chat/sessions/{session_id}","sidebarTitle":"Update","title":"Update a chat session","href":"/api-reference/chat-sessions/update"},{"sidebarTitle":"Set Custom Status","openapi":"put /chat/sessions/{session_id}/sub-status","title":"Set the custom status of a chat session","href":"/api-reference/chat-sessions/sub_status_set"},{"sidebarTitle":"Clear Custom Status","openapi":"delete /chat/sessions/{session_id}/sub-status","title":"Clear the custom status of a chat session","href":"/api-reference/chat-sessions/sub_status_clear"},{"sidebarTitle":"Get Structured Field Values","openapi":"get /chat/sessions/{session_id}/structured-field-values","title":"Get session structured field values","href":"/api-reference/chat-sessions/structured_field_values_get"},{"sidebarTitle":"Set Structured Field Values","openapi":"put /chat/sessions/{session_id}/structured-field-values","title":"Set session structured field values","href":"/api-reference/chat-sessions/structured_field_values_set"},{"sidebarTitle":"Assign","openapi":"post /chat/sessions/{session_id}/assignee","title":"Assign or unassign a chat session","href":"/api-reference/chat-sessions/assignee"},{"sidebarTitle":"Change contact","openapi":"post /chat/sessions/{session_id}/contact","title":"Change the contact of a chat session","href":"/api-reference/chat-sessions/contact"},{"sidebarTitle":"Transfer to Team","openapi":"post /chat/sessions/{session_id}/team","title":"Transfer a chat session to a team","href":"/api-reference/chat-sessions/team"},{"sidebarTitle":"Add Tag","openapi":"post /chat/sessions/{session_id}/tags","title":"Add a tag to a chat session","href":"/api-reference/chat-sessions/add_tag"},{"sidebarTitle":"Remove Tag","openapi":"delete /chat/sessions/{session_id}/tags/{tag_name}","title":"Remove a tag from a chat session","href":"/api-reference/chat-sessions/remove_tag"},{"openapi":"post /chat/sessions/{session_id}/send","sidebarTitle":"Send","title":"Send a message","href":"/api-reference/chat-sessions/send"},{"openapi":"post /chat/sessions/{session_id}/comments","sidebarTitle":"Create comment","title":"Create a session comment","href":"/api-reference/chat-sessions/create_comment"},{"openapi":"patch /chat/sessions/{session_id}/comments/{comment_uuid}","sidebarTitle":"Update comment","title":"Update a session comment","href":"/api-reference/chat-sessions/update_comment"},{"openapi":"delete /chat/sessions/{session_id}/comments/{comment_uuid}","sidebarTitle":"Delete comment","description":"Delete a session comment — Removes an internal note from a chat session. Only the agent who authored the note may delete it.","title":"Delete a session comment","href":"/api-reference/chat-sessions/delete_comment"},{"openapi":"patch /chat/sessions/{session_id}/ai-suggestions/{suggestion_id}","sidebarTitle":"Update AI suggestion","title":"Update an AI suggestion","href":"/api-reference/chat-sessions/update_ai_suggestion"},{"openapi":"post /chat/sessions/{session_id}/handoff","sidebarTitle":"Handoff","description":"Hand off a chat session — Hands the session off to a human agent, re-running the pipeline even if already handed off. Use to escalate a conversation from code.","title":"Hand the session off to a human agent","href":"/api-reference/chat-sessions/handoff"},{"openapi":"get /chat/sessions/{session_id}/history","sidebarTitle":"List history","title":"List chat session history","href":"/api-reference/chat-sessions/list_history"},{"title":"Export session events","openapi":"get /chat/sessions/events","sidebarTitle":"Export events","href":"/api-reference/chat-sessions/list_events"},{"openapi":"get /chat/sessions/search","sidebarTitle":"Search","title":"Search contacts and messages","href":"/api-reference/chat-sessions/search"},{"openapi":"get /chat/sessions/ticket/{ticket_number}/investigation","sidebarTitle":"Investigate a chat session by ticket number","title":"Investigate a chat session by ticket number","href":"/api-reference/chat-sessions/get-chat-session-investigation-by-ticket-number"},{"openapi":"get /chat/sessions/ticket/{ticket_number}","sidebarTitle":"Get a chat session by ticket number","title":"Get a chat session by ticket number","href":"/api-reference/chat-sessions/get-chat-session-by-ticket-number"},{"openapi":"get /chat/sessions/{session_id}/tags","sidebarTitle":"Get session tags","title":"Get session tags","href":"/api-reference/chat-sessions/get-session-tags"},{"openapi":"get /chat/sessions/{session_id}/handoffs","sidebarTitle":"Get session handoff event","title":"Get session handoff event","href":"/api-reference/chat-sessions/get-session-handoffs"},{"openapi":"post /chat/sessions/{session_id}/follow-ups","sidebarTitle":"Schedule an AI follow-up on a chat session","title":"Schedule an AI follow-up on a chat session","href":"/api-reference/chat-sessions/create-chat-session-follow-up"},{"openapi":"get /chat/sessions/{session_id}/follow-ups","sidebarTitle":"List scheduled AI follow-ups","title":"List the AI follow-ups scheduled on a chat session","href":"/api-reference/chat-sessions/list-chat-session-follow-ups"},{"openapi":"delete /chat/sessions/{session_id}/follow-ups/{follow_up_id}","sidebarTitle":"Cancel a pending AI follow-up","title":"Cancel a pending AI follow-up","href":"/api-reference/chat-sessions/cancel-chat-session-follow-up"}]},{"group":"Session sidebar","pages":[{"openapi":"get /session-sidebar","sidebarTitle":"Get layout","title":"Get the session sidebar layout","href":"/api-reference/session-sidebar/get"},{"openapi":"put /session-sidebar","sidebarTitle":"Update layout","title":"Update the session sidebar layout","href":"/api-reference/session-sidebar/update"}]},{"group":"Inbox Views","pages":[{"title":"Inbox Views","icon":"filter","href":"/api-reference/inbox-views/index"},{"sidebarTitle":"List","openapi":"get /inbox-views","title":"List saved inbox views","href":"/api-reference/inbox-views/list"},{"sidebarTitle":"Create","openapi":"post /inbox-views","title":"Create a saved inbox view","href":"/api-reference/inbox-views/create"},{"sidebarTitle":"Update","openapi":"patch /inbox-views/{id}","title":"Update a saved inbox view","href":"/api-reference/inbox-views/update"},{"sidebarTitle":"Delete","openapi":"delete /inbox-views/{id}","title":"Delete a saved inbox view","href":"/api-reference/inbox-views/delete"}]},{"group":"Macros","pages":[{"title":"Macros","icon":"reply","href":"/api-reference/macros/index"},{"openapi":"get /macros","sidebarTitle":"List","title":"List macros","href":"/api-reference/macros/list"},{"openapi":"get /macros/{id}","sidebarTitle":"Get","title":"Get a macro","href":"/api-reference/macros/get"},{"openapi":"post /macros","sidebarTitle":"Create","title":"Create a macro","href":"/api-reference/macros/create"},{"openapi":"patch /macros/{id}","sidebarTitle":"Update","title":"Update a macro","href":"/api-reference/macros/update"},{"openapi":"delete /macros/{id}","sidebarTitle":"Delete","title":"Delete a macro","href":"/api-reference/macros/delete"},{"openapi":"get /macros/variables","sidebarTitle":"List variables","title":"List macro variables","href":"/api-reference/macros/variables"},{"openapi":"get /macros/settings","sidebarTitle":"Get settings","title":"Get macro settings","href":"/api-reference/macros/get-settings"},{"openapi":"put /macros/settings","sidebarTitle":"Update settings","title":"Update macro settings","href":"/api-reference/macros/update-settings"},{"openapi":"get /macros/{id}/translations","sidebarTitle":"Get translations","title":"Get macro translations","href":"/api-reference/macros/translations"},{"openapi":"post /macros/{id}/translations/retranslate","sidebarTitle":"Retranslate","title":"Retranslate a macro","href":"/api-reference/macros/retranslate"},{"openapi":"put /macros/{id}/translations/{language}","sidebarTitle":"Set translation","title":"Set a macro translation","href":"/api-reference/macros/set-translation"},{"openapi":"get /macros/suggestion-insights","sidebarTitle":"List suggestion insights","title":"List macro suggestion insights","href":"/api-reference/macros/suggestion-insights-list"},{"openapi":"get /macros/{id}/suggestion-insights","sidebarTitle":"Get suggestion insights","title":"Get macro suggestion insights","href":"/api-reference/macros/suggestion-insights-get"}]},{"group":"Tags","pages":[{"title":"Tags","icon":"tags","href":"/api-reference/tags/index"},{"sidebarTitle":"List","openapi":"get /tags","title":"List tags","href":"/api-reference/tags/list"},{"openapi":"get /tags/in-use","sidebarTitle":"In use","title":"List tags in use","href":"/api-reference/tags/in_use"},{"openapi":"put /tags","sidebarTitle":"Upsert","title":"Create or update a tag","href":"/api-reference/tags/upsert"},{"openapi":"delete /tags/{tag_name}","sidebarTitle":"Delete","title":"Delete a tag","href":"/api-reference/tags/delete"},{"group":"Categories","icon":"folder-tree","pages":[{"sidebarTitle":"List","openapi":"get /tags/categories","title":"List tag categories","href":"/api-reference/tags/categories/list"},{"sidebarTitle":"Create","openapi":"post /tags/categories","title":"Create a tag category","href":"/api-reference/tags/categories/create"},{"sidebarTitle":"Update","openapi":"put /tags/categories/{id}","title":"Update a tag category","href":"/api-reference/tags/categories/update"},{"sidebarTitle":"Delete","openapi":"delete /tags/categories/{id}","title":"Delete a tag category","href":"/api-reference/tags/categories/delete"}]},{"openapi":"get /tags/auto-tagging","sidebarTitle":"Auto tagging get","title":"Get auto-tagging status","href":"/api-reference/tags/auto_tagging_get"},{"openapi":"put /tags/auto-tagging","sidebarTitle":"Auto tagging set","title":"Enable or disable auto-tagging","href":"/api-reference/tags/auto_tagging_set"}]},{"group":"Custom Statuses","pages":[{"title":"Custom Statuses","icon":"circle-half-stroke","href":"/api-reference/custom-statuses/index"},{"sidebarTitle":"List","openapi":"get /custom-statuses","title":"List custom statuses","href":"/api-reference/custom-statuses/list"},{"sidebarTitle":"Get","openapi":"get /custom-statuses/{id}","title":"Get a custom status","href":"/api-reference/custom-statuses/get"},{"sidebarTitle":"Create","openapi":"post /custom-statuses","title":"Create a custom status","href":"/api-reference/custom-statuses/create"},{"sidebarTitle":"Update","openapi":"patch /custom-statuses/{id}","title":"Update a custom status","href":"/api-reference/custom-statuses/update"},{"sidebarTitle":"Delete","openapi":"delete /custom-statuses/{id}","title":"Delete a custom status","href":"/api-reference/custom-statuses/delete"}]},{"group":"Structured Fields","pages":[{"openapi":"get /structured-fields","sidebarTitle":"List Structured Fields","title":"List Structured Fields","href":"/api-reference/structured-fields/list-structured-fields"},{"openapi":"post /structured-fields","sidebarTitle":"Create a structured field","title":"Create a structured field","href":"/api-reference/structured-fields/create-structured-field"},{"openapi":"patch /structured-fields/{fieldId}","sidebarTitle":"Update a structured field","title":"Update a structured field","href":"/api-reference/structured-fields/update-structured-field"},{"openapi":"delete /structured-fields/{fieldId}","sidebarTitle":"Delete a structured field","title":"Delete a structured field","href":"/api-reference/structured-fields/delete-structured-field"},{"openapi":"post /structured-fields/{fieldId}/variants","sidebarTitle":"Create a structured field choice","title":"Create a structured field choice","href":"/api-reference/structured-fields/create-structured-field-choice"},{"openapi":"patch /structured-fields/{fieldId}/variants/{optionId}","sidebarTitle":"Update a structured field choice","title":"Rename, redescribe, or re-parent a structured field choice","href":"/api-reference/structured-fields/update-structured-field-choice"},{"openapi":"delete /structured-fields/{fieldId}/variants/{optionId}","sidebarTitle":"Delete a structured field choice","title":"Delete a structured field choice","href":"/api-reference/structured-fields/delete-structured-field-choice"},{"openapi":"get /structured-fields/groups","sidebarTitle":"List structured field groups","title":"List structured field groups","href":"/api-reference/structured-fields/list-structured-field-groups"},{"openapi":"post /structured-fields/groups","sidebarTitle":"Create a structured field group","title":"Create a structured field group","href":"/api-reference/structured-fields/create-structured-field-group"},{"openapi":"patch /structured-fields/groups/{groupId}","sidebarTitle":"Update a structured field group","title":"Update a structured field group","href":"/api-reference/structured-fields/update-structured-field-group"},{"openapi":"delete /structured-fields/groups/{groupId}","sidebarTitle":"Delete a structured field group","title":"Delete a structured field group","href":"/api-reference/structured-fields/delete-structured-field-group"}]},{"group":"CSAT","pages":[{"title":"CSAT","icon":"face-smile","href":"/api-reference/csat/index"},{"openapi":"get /csat/scores","sidebarTitle":"Get all","title":"Get all CSAT scores","href":"/api-reference/csat/get_all"},{"openapi":"get /csat/scores/{score_id}","sidebarTitle":"Get","title":"Get specific CSAT score","href":"/api-reference/csat/get"},{"openapi":"get /csat/scores/session/{session_id}","sidebarTitle":"Get session","title":"Get session CSAT score","href":"/api-reference/csat/get_session"},{"openapi":"get /csat/settings/channel/{channel}","sidebarTitle":"Check channel","title":"Check if CSAT is enabled for a channel","href":"/api-reference/csat/check_channel"},{"openapi":"get /csat/sessions/{session_id}/sent","sidebarTitle":"Check sent","title":"Check if CSAT has been sent for a session","href":"/api-reference/csat/check_sent"},{"openapi":"get /csat/settings","sidebarTitle":"Get settings","title":"Get CSAT settings","href":"/api-reference/csat/get-settings"},{"openapi":"patch /csat/settings","sidebarTitle":"Update settings","title":"Update CSAT settings","href":"/api-reference/csat/update-settings"}]},{"group":"NPS","pages":[{"title":"NPS API","sidebarTitle":"NPS","icon":"star","href":"/api-reference/nps/index"},{"openapi":"get /nps/scores","sidebarTitle":"Get all","title":"Get all NPS scores","href":"/api-reference/nps/get_all"},{"openapi":"get /nps/scores/{score_id}","sidebarTitle":"Get","title":"Get specific NPS score","href":"/api-reference/nps/get"},{"openapi":"get /nps/scores/session/{session_id}","sidebarTitle":"Get session","title":"Get session NPS score","href":"/api-reference/nps/get_session"},{"openapi":"get /nps/settings/channel/{channel}","sidebarTitle":"Check channel","title":"Check if NPS is enabled for a channel","href":"/api-reference/nps/check_channel"},{"openapi":"get /nps/sessions/{session_id}/sent","sidebarTitle":"Check sent","title":"Check if NPS has been sent for a session","href":"/api-reference/nps/check_sent"},{"openapi":"get /nps/settings","sidebarTitle":"Get settings","title":"Get NPS settings","href":"/api-reference/nps/get-settings"},{"openapi":"patch /nps/settings","sidebarTitle":"Update settings","title":"Update NPS settings","href":"/api-reference/nps/update-settings"}]},{"group":"CES","pages":[{"title":"CES API","sidebarTitle":"CES","icon":"star","href":"/api-reference/ces/index"},{"openapi":"get /ces/scores","sidebarTitle":"Get all","title":"Get all CES scores","href":"/api-reference/ces/get_all"},{"openapi":"get /ces/scores/{score_id}","sidebarTitle":"Get","title":"Get specific CES score","href":"/api-reference/ces/get"},{"openapi":"get /ces/scores/session/{session_id}","sidebarTitle":"Get session","title":"Get session CES score","href":"/api-reference/ces/get_session"},{"openapi":"get /ces/settings/channel/{channel}","sidebarTitle":"Check channel","title":"Check if CES is enabled for a channel","href":"/api-reference/ces/check_channel"},{"openapi":"get /ces/sessions/{session_id}/sent","sidebarTitle":"Check sent","title":"Check if CES has been sent for a session","href":"/api-reference/ces/check_sent"},{"openapi":"get /ces/settings","sidebarTitle":"Get settings","title":"Get CES settings","href":"/api-reference/ces/get-settings"},{"openapi":"patch /ces/settings","sidebarTitle":"Update settings","title":"Update CES settings","href":"/api-reference/ces/update-settings"}]},{"group":"Redaction","pages":[{"title":"Redaction","icon":"eye-slash","href":"/api-reference/redaction/index"},{"openapi":"post /redaction/message","sidebarTitle":"Redact message","title":"Redact a specific message","href":"/api-reference/redaction/redact-message"},{"openapi":"post /redaction/session","sidebarTitle":"Redact session","title":"Redact all messages in a session","href":"/api-reference/redaction/redact-session"}]},{"group":"Session retention","pages":[{"openapi":"get /session-retention/settings","sidebarTitle":"Get settings","title":"Get session retention settings","href":"/api-reference/session-retention/get-settings"},{"openapi":"put /session-retention/settings","sidebarTitle":"Update settings","title":"Update session retention settings","href":"/api-reference/session-retention/update-settings"}]},{"group":"Media","pages":[{"title":"Media","icon":"image","href":"/api-reference/media/index"},{"openapi":"post /media/upload","sidebarTitle":"Upload media","title":"Upload an image or document","href":"/api-reference/media/upload"}]}]},{"group":"Customers","pages":[{"group":"Contacts","pages":[{"title":"Introduction to contacts","icon":"user","href":"/api-reference/contacts/introduction"},{"openapi":"post /contacts","sidebarTitle":"Create","title":"Create a contact","href":"/api-reference/contacts/create"},{"sidebarTitle":"Get","openapi":"get /contacts/{contact_id}","title":"Get a contact","href":"/api-reference/contacts/get"},{"sidebarTitle":"List","openapi":"get /contacts","title":"List contacts","href":"/api-reference/contacts/list"},{"sidebarTitle":"Search","openapi":"post /contacts/search","title":"Search contacts","href":"/api-reference/contacts/search"},{"openapi":"patch /contacts/{contact_id}","sidebarTitle":"Update","title":"Update a contact","href":"/api-reference/contacts/update"},{"openapi":"delete /contacts/{contact_id}","sidebarTitle":"Delete","title":"Delete a contact","href":"/api-reference/contacts/delete"},{"sidebarTitle":"Get Structured Field Values","openapi":"get /contacts/{contact_id}/structured-field-values","title":"Get contact structured field values","href":"/api-reference/contacts/get-structured-field-values"},{"sidebarTitle":"Set Structured Field Values","openapi":"put /contacts/{contact_id}/structured-field-values","title":"Set contact structured field values","href":"/api-reference/contacts/set-structured-field-values"},{"openapi":"put /contacts/{contact_id}/restricted-channels","sidebarTitle":"Set Restricted Channels","title":"Set contact restricted channels","href":"/api-reference/contacts/set-restricted-channels"},{"openapi":"post /widget/authenticate-user","sidebarTitle":"Authenticate contact","title":"Authenticate a widget user","href":"/api-reference/widget/authenticate-contact"},{"openapi":"post /widget/authenticate-user-by-phone","sidebarTitle":"Authenticate contact by phone","title":"Authenticate a widget user by phone number","href":"/api-reference/widget/authenticate-contact-by-phone"},{"openapi":"post /widget/authenticate-user-by-external-id","sidebarTitle":"Authenticate contact by external ID","title":"Authenticate a widget user by your own user id","href":"/api-reference/widget/authenticate-contact-by-external-id"},{"openapi":"post /widget/revoke-user","sidebarTitle":"Revoke contact","title":"Revoke a widget user","href":"/api-reference/widget/revoke-contact"},{"group":"Segments","pages":[{"title":"Introduction to contact segments","icon":"users","href":"/api-reference/contacts/segments/introduction"},{"openapi":"get /contacts/segments","sidebarTitle":"List","title":"List contact segments","href":"/api-reference/contacts/segments/list"},{"openapi":"get /contacts/segments/{segment_id}","sidebarTitle":"Get","title":"Get a contact segment","href":"/api-reference/contacts/segments/get"},{"title":"Create a contact segment","sidebarTitle":"Create","openapi":"POST /contacts/segments","href":"/api-reference/contacts/segments/create"},{"title":"Update a contact segment","sidebarTitle":"Update","openapi":"PATCH /contacts/segments/{segment_id}","href":"/api-reference/contacts/segments/update"},{"title":"Delete a contact segment","sidebarTitle":"Delete","openapi":"DELETE /contacts/segments/{segment_id}","href":"/api-reference/contacts/segments/delete"},{"openapi":"get /contacts/segments/contacts/{contact_id}","sidebarTitle":"List for contact","title":"List segments for a contact","href":"/api-reference/contacts/segments/list-for-contact"},{"openapi":"get /contacts/segments/{segment_id}/contacts/{contact_id}","sidebarTitle":"Check membership","title":"Check contact segment membership","href":"/api-reference/contacts/segments/check"}]},{"group":"Companies","pages":[{"openapi":"get /contacts/{contact_id}/companies","sidebarTitle":"List","title":"List a contact's companies","href":"/api-reference/contacts/companies/list"},{"openapi":"post /contacts/{contact_id}/companies","sidebarTitle":"Link","title":"Add a company to a contact","href":"/api-reference/contacts/companies/link"},{"openapi":"delete /contacts/{contact_id}/companies/{external_id}","sidebarTitle":"Unlink","title":"Remove one company from a contact","href":"/api-reference/contacts/companies/unlink"}]},{"openapi":"get /custom-data-keys","sidebarTitle":"List the org's observed custom-data keys","title":"List the org's observed custom-data keys (names only)","href":"/api-reference/contacts/list-custom-data-keys"}]},{"group":"Companies","pages":[{"title":"Introduction to companies","icon":"building","href":"/api-reference/companies/introduction"},{"openapi":"post /companies","sidebarTitle":"Upsert","title":"Create or update a company","href":"/api-reference/companies/upsert"},{"openapi":"get /companies","sidebarTitle":"List","title":"List companies","href":"/api-reference/companies/list"},{"openapi":"post /companies/search","sidebarTitle":"Search","title":"Search companies","href":"/api-reference/companies/search"},{"openapi":"get /companies/{company_id}","sidebarTitle":"Get","title":"Retrieve a company","href":"/api-reference/companies/get"},{"openapi":"put /companies/{external_id}/owner","sidebarTitle":"Set owner","title":"Set a company's owning teammate","href":"/api-reference/companies/set-owner"},{"openapi":"post /companies/links","sidebarTitle":"Bulk link","title":"Link many contacts to companies","href":"/api-reference/companies/bulk-link"},{"openapi":"post /companies/{external_id}/link-contacts-by-domain","sidebarTitle":"Link by domain","title":"Link existing contacts by the company's domains","href":"/api-reference/companies/link-by-domain"}]},{"group":"Blocklist","pages":[{"title":"Blocklist","icon":"ban","href":"/api-reference/blocklist/index"},{"openapi":"get /blocklist/contacts","sidebarTitle":"List contacts","title":"List blocked contacts","href":"/api-reference/blocklist/list_contacts"},{"openapi":"post /blocklist/contacts","sidebarTitle":"Block contact","title":"Block a contact","href":"/api-reference/blocklist/block_contact"},{"openapi":"get /blocklist/contacts/check/{contact_id}","sidebarTitle":"Check contact","title":"Check if a contact is blocked","href":"/api-reference/blocklist/check_contact"},{"openapi":"delete /blocklist/contacts/{id}","sidebarTitle":"Unblock contact","title":"Unblock a contact","href":"/api-reference/blocklist/unblock_contact"},{"openapi":"get /blocklist/domains","sidebarTitle":"List domains","title":"List blocked domains","href":"/api-reference/blocklist/list_domains"},{"openapi":"post /blocklist/domains","sidebarTitle":"Block domains","title":"Block email domains","href":"/api-reference/blocklist/block_domains"},{"openapi":"get /blocklist/domains/check","sidebarTitle":"Check domain","title":"Check if a domain or email is blocked","href":"/api-reference/blocklist/check_domain"},{"openapi":"delete /blocklist/domains/{id}","sidebarTitle":"Unblock domain","title":"Unblock a domain","href":"/api-reference/blocklist/unblock_domain"},{"openapi":"get /blocklist/ips","sidebarTitle":"List blocked IPs","title":"List blocked IPs","href":"/api-reference/blocklist/list_ips"},{"openapi":"post /blocklist/ips","sidebarTitle":"Block IPs","title":"Block IP addresses","href":"/api-reference/blocklist/block_ips"},{"openapi":"get /blocklist/ips/check","sidebarTitle":"Check IP","title":"Check if an IP is blocked","href":"/api-reference/blocklist/check_ip"},{"openapi":"delete /blocklist/ips/{id}","sidebarTitle":"Unblock IP","title":"Unblock an IP","href":"/api-reference/blocklist/unblock_ip"},{"openapi":"get /blocklist/ips/session-activity","sidebarTitle":"Session IP activity","title":"List IP addresses seen in recent sessions","href":"/api-reference/blocklist/session_ip_activity"}]}]},{"group":"AI agent","pages":[{"group":"AI Training","pages":[{"title":"AI Training","icon":"graduation-cap","href":"/api-reference/training/index"},{"sidebarTitle":"Create","openapi":"post /training","title":"Create a training","href":"/api-reference/training/create"},{"openapi":"get /training/{id}","sidebarTitle":"Get","title":"Get a training","href":"/api-reference/training/get"},{"openapi":"put /training/{id}","sidebarTitle":"Update","title":"Update a training","href":"/api-reference/training/update"},{"openapi":"delete /training/{id}","sidebarTitle":"Delete","title":"Delete a training","href":"/api-reference/training/delete"},{"openapi":"put /training/{id}/draft","sidebarTitle":"Toggle draft","title":"Toggle draft status","href":"/api-reference/training/toggle_draft"},{"openapi":"post /training/{id}/move","sidebarTitle":"Move","title":"Move a training to a directory","href":"/api-reference/training/move"},{"openapi":"post /training/search","sidebarTitle":"Search","title":"Semantic search across training and knowledge base","href":"/api-reference/training/search"},{"group":"Directories","icon":"folder","pages":[{"openapi":"get /training/directories","sidebarTitle":"List directories","title":"List training directories","href":"/api-reference/training/list_directories"},{"openapi":"get /training/directories/tree","sidebarTitle":"Get directory tree","title":"Get directory tree","href":"/api-reference/training/get_directory_tree"},{"openapi":"post /training/directories","sidebarTitle":"Create directory","title":"Create a training directory","href":"/api-reference/training/create_directory"},{"openapi":"put /training/directories/{directory_id}","sidebarTitle":"Update directory","title":"Update a training directory","href":"/api-reference/training/update_directory"},{"openapi":"delete /training/directories/{directory_id}","sidebarTitle":"Delete directory","title":"Delete a training directory","href":"/api-reference/training/delete_directory"}]},{"group":"Knowledge base items","icon":"database","pages":[{"openapi":"get /knowledgebase-items","sidebarTitle":"List items","title":"List knowledge base items","href":"/api-reference/knowledge-base-items/list"},{"openapi":"get /knowledgebase-items/folders","sidebarTitle":"List folders","title":"List knowledge base folders","href":"/api-reference/knowledge-base-items/list_folders"},{"openapi":"put /knowledgebase-items/folders/visibility","sidebarTitle":"Switch a folder on or off","title":"Switch a knowledge base folder on or off","href":"/api-reference/knowledge-base-items/set_folder_visibility"}]},{"openapi":"put /knowledgebase-items/{id}","sidebarTitle":"Update a knowledge base item","title":"Update a knowledge base item","href":"/api-reference/training/update-knowledgebase-item"},{"openapi":"get /training/ai-profile","sidebarTitle":"Get AI profile","title":"Get AI profile","href":"/api-reference/training/get-ai-profile"},{"openapi":"patch /training/ai-profile","sidebarTitle":"Update AI profile","title":"Update AI profile","href":"/api-reference/training/update-ai-profile"},{"openapi":"post /training/ai-profile/publish","sidebarTitle":"Publish AI profile draft","title":"Publish AI profile draft","href":"/api-reference/training/publish-ai-profile-draft"},{"openapi":"post /training/ai-profile/discard-draft","sidebarTitle":"Discard AI profile draft","title":"Discard AI profile draft","href":"/api-reference/training/discard-ai-profile-draft"},{"openapi":"get /training/{instructionId}/versions","sidebarTitle":"Get version history","title":"Get version history","href":"/api-reference/training/get-training-version-history"},{"openapi":"post /training/{instructionId}/versions/{version}/revert","sidebarTitle":"Revert to a previous version","title":"Revert to a previous version","href":"/api-reference/training/revert-training-version"},{"openapi":"put /training/{id}/restrictions","sidebarTitle":"Update instruction restrictions","title":"Update instruction restrictions","href":"/api-reference/training/update-training-restrictions"},{"openapi":"put /training/{id}/diff","sidebarTitle":"Apply targeted diff edits to a training scenario","title":"Apply targeted diff edits to a training scenario","href":"/api-reference/training/apply-training-diff"},{"openapi":"post /training/{id}/publish","sidebarTitle":"Publish a draft training scenario","title":"Publish a draft training scenario","href":"/api-reference/training/publish-training"},{"openapi":"patch /training/{id}/metadata","sidebarTitle":"Update training metadata","title":"Update training metadata","href":"/api-reference/training/update-training-metadata"},{"openapi":"get /training","sidebarTitle":"Get all","title":"List all trainings","href":"/api-reference/training/get_all"}]},{"group":"Crawl","pages":[{"title":"Crawl","icon":"spider","href":"/api-reference/crawl/index"},{"openapi":"post /crawl","sidebarTitle":"Create datasource","title":"Create a website datasource","href":"/api-reference/crawl/create-datasource"},{"openapi":"get /crawl","sidebarTitle":"List datasources","title":"List website datasources","href":"/api-reference/crawl/list-datasources"},{"openapi":"get /crawl/{id}","sidebarTitle":"Get datasource","title":"Get website datasource details","href":"/api-reference/crawl/get-datasource"},{"openapi":"patch /crawl/{id}","sidebarTitle":"Update datasource","title":"Update website datasource settings","href":"/api-reference/crawl/update-datasource"},{"openapi":"delete /crawl/{id}","sidebarTitle":"Delete datasource","title":"Delete a website datasource","href":"/api-reference/crawl/delete-datasource"},{"openapi":"post /crawl/{id}/crawl","sidebarTitle":"Start crawl","title":"Start a new crawl","href":"/api-reference/crawl/start-crawl"},{"openapi":"delete /crawl/{id}/crawl","sidebarTitle":"Cancel crawl","title":"Cancel active crawl","href":"/api-reference/crawl/cancel-crawl"},{"openapi":"get /crawl/{id}/crawls","sidebarTitle":"List crawl jobs","title":"List crawl history","href":"/api-reference/crawl/list-crawl-jobs"},{"openapi":"get /crawl/{id}/crawls/{jobId}","sidebarTitle":"Get crawl job","title":"Get crawl job status","href":"/api-reference/crawl/get-crawl-job"},{"openapi":"get /crawl/{id}/pages","sidebarTitle":"List pages","title":"List crawled pages","href":"/api-reference/crawl/list-pages"},{"openapi":"post /crawl/{id}/pages/exclude","sidebarTitle":"Exclude pages","title":"Exclude pages from sync","href":"/api-reference/crawl/exclude-pages"},{"openapi":"post /crawl/{id}/pages/include","sidebarTitle":"Include pages","title":"Include excluded pages back into sync","href":"/api-reference/crawl/include-pages"},{"openapi":"post /crawl/{id}/pages/delete","sidebarTitle":"Delete pages","title":"Delete pages","href":"/api-reference/crawl/delete-crawl-pages"},{"openapi":"post /crawl/{id}/pages/sync","sidebarTitle":"Scrape and sync a page by URL","title":"Scrape and sync a page by URL","href":"/api-reference/crawl/sync-crawl-page-by-url"},{"openapi":"post /crawl/{id}/pages/{pageId}/resync","sidebarTitle":"Resync a single page","title":"Resync a single page","href":"/api-reference/crawl/resync-crawl-page"}]},{"group":"Help Center","pages":[{"title":"Help Center API","sidebarTitle":"Overview","icon":"book-open","href":"/api-reference/help-center/index"},{"openapi":"get /hc","sidebarTitle":"List help centers","title":"List help centers","href":"/api-reference/help-center/list"},{"openapi":"get /hc/{id}","sidebarTitle":"Get","title":"Get a help center","href":"/api-reference/help-center/get"},{"openapi":"put /hc/{id}","sidebarTitle":"Update","title":"Update a help center","href":"/api-reference/help-center/update"},{"group":"Languages","icon":"language","pages":[{"openapi":"get /hc/{id}/languages","sidebarTitle":"Get languages","title":"Get the languages a help center serves","href":"/api-reference/help-center/languages/get"},{"openapi":"put /hc/{id}/languages","sidebarTitle":"Update languages","title":"Change which languages a help center serves","href":"/api-reference/help-center/languages/update"},{"openapi":"get /hc/{id}/translation-jobs","sidebarTitle":"Translation jobs","title":"List translations still running","href":"/api-reference/help-center/translation_jobs"}]},{"group":"Glossary","icon":"book","pages":[{"openapi":"get /hc/{id}/glossary","sidebarTitle":"List terms","title":"List the translation glossary","href":"/api-reference/help-center/glossary/list"},{"openapi":"post /hc/{id}/glossary","sidebarTitle":"Add term","title":"Add a glossary term","href":"/api-reference/help-center/glossary/create"},{"openapi":"put /hc/{id}/glossary/{termId}","sidebarTitle":"Update term","title":"Update a glossary term","href":"/api-reference/help-center/glossary/update"},{"openapi":"delete /hc/{id}/glossary/{termId}","sidebarTitle":"Delete term","title":"Delete a glossary term","href":"/api-reference/help-center/glossary/delete"},{"openapi":"post /hc/{id}/glossary/import-from-translation","sidebarTitle":"Import terms","title":"Import glossary terms from the organization glossary","href":"/api-reference/help-center/glossary/import"}]},{"group":"Articles","icon":"file-lines","pages":[{"openapi":"get /hc/{helpCenterId}/articles","sidebarTitle":"List","title":"List help center articles","href":"/api-reference/help-center/articles/list"},{"openapi":"get /hc/{helpCenterId}/articles/{entityId}","sidebarTitle":"Get","title":"Get a help center article","href":"/api-reference/help-center/articles/get"},{"openapi":"post /hc/{helpCenterId}/articles","sidebarTitle":"Create","title":"Create a help center article","href":"/api-reference/help-center/articles/create"},{"openapi":"put /hc/{helpCenterId}/articles/{entityId}","sidebarTitle":"Update","title":"Update a help center article","href":"/api-reference/help-center/articles/update"},{"openapi":"put /hc/{helpCenterId}/articles/{entityId}/diff","sidebarTitle":"Propose changes","title":"Propose changes to a help center article","href":"/api-reference/help-center/articles/propose"},{"openapi":"delete /hc/{helpCenterId}/articles/{entityId}","sidebarTitle":"Delete","title":"Delete a help center article","href":"/api-reference/help-center/articles/delete"},{"openapi":"post /hc/{helpCenterId}/articles/{entityId}/restore-deleted","sidebarTitle":"Restore","title":"Restore a deleted help center article","href":"/api-reference/help-center/articles/restore"},{"openapi":"get /hc/{helpCenterId}/articles/{entityId}/versions","sidebarTitle":"List versions","title":"List versions of a help center article","href":"/api-reference/help-center/articles/versions"},{"openapi":"get /hc/{helpCenterId}/articles/{entityId}/backlinks","sidebarTitle":"List backlinks","title":"List the articles that link to a help center article","href":"/api-reference/help-center/articles/backlinks"},{"openapi":"get /hc/{helpCenterId}/articles/{entityId}/language-states","sidebarTitle":"Language states","title":"Get the per-language state of a help center article","href":"/api-reference/help-center/articles/language_states"},{"openapi":"post /hc/{helpCenterId}/articles/{entityId}/publish","sidebarTitle":"Publish","title":"Publish a help center article (all locales)","href":"/api-reference/help-center/articles/publish"},{"openapi":"post /hc/{helpCenterId}/articles/{entityId}/locales/{languageCode}/publish","sidebarTitle":"Publish one locale","title":"Publish one locale of a help center article","href":"/api-reference/help-center/articles/publish_locale"},{"openapi":"post /hc/{helpCenterId}/articles/{entityId}/unpublish","sidebarTitle":"Unpublish","title":"Unpublish a help center article","href":"/api-reference/help-center/articles/unpublish"},{"openapi":"post /hc/{helpCenterId}/articles/{entityId}/retranslate","sidebarTitle":"Retranslate","title":"Retranslate a help center article into one language","href":"/api-reference/help-center/articles/retranslate"},{"openapi":"post /hc/{helpCenterId}/articles/{entityId}/retranslate-all","sidebarTitle":"Retranslate all","title":"Retranslate a help center article into every enabled language","href":"/api-reference/help-center/articles/retranslate_all"}]},{"group":"Categories","icon":"folder-tree","pages":[{"openapi":"get /hc/{helpCenterId}/categories","sidebarTitle":"List","title":"List help center topics","href":"/api-reference/help-center/categories/list"},{"openapi":"get /hc/{helpCenterId}/categories/{categoryEntityId}","sidebarTitle":"Get","title":"Get a help center topic","href":"/api-reference/help-center/categories/get"},{"openapi":"post /hc/{helpCenterId}/categories","sidebarTitle":"Create","title":"Create a help center topic","href":"/api-reference/help-center/categories/create"},{"openapi":"put /hc/{helpCenterId}/categories/{categoryEntityId}","sidebarTitle":"Update","title":"Update a help center topic","href":"/api-reference/help-center/categories/update"},{"openapi":"delete /hc/{helpCenterId}/categories/{categoryEntityId}","sidebarTitle":"Delete","title":"Delete a help center topic","href":"/api-reference/help-center/categories/delete"},{"openapi":"post /hc/{helpCenterId}/categories/{categoryEntityId}/restore-deleted","sidebarTitle":"Restore","title":"Restore a deleted help center topic","href":"/api-reference/help-center/categories/restore"},{"openapi":"post /hc/{helpCenterId}/categories/{categoryEntityId}/retranslate","sidebarTitle":"Retranslate","title":"Retranslate a help center topic into one language","href":"/api-reference/help-center/categories/retranslate"},{"openapi":"post /hc/{helpCenterId}/categories/{categoryEntityId}/retranslate-all","sidebarTitle":"Retranslate all","title":"Retranslate a help center topic into every enabled language","href":"/api-reference/help-center/categories/retranslate_all"}]},{"group":"Structure","icon":"folder-tree","pages":[{"openapi":"get /hc/{helpCenterId}/structure/tree","sidebarTitle":"Get tree","title":"Get the help center content tree","href":"/api-reference/help-center/structure/tree"},{"openapi":"post /hc/{helpCenterId}/structure/move-article","sidebarTitle":"Move article","title":"Move an article to a topic","href":"/api-reference/help-center/structure/move_article"},{"openapi":"post /hc/{helpCenterId}/structure/move-topic","sidebarTitle":"Move category","title":"Move a topic under another topic","href":"/api-reference/help-center/structure/move_topic"},{"openapi":"post /hc/{helpCenterId}/structure/reorder","sidebarTitle":"Reorder","title":"Reorder the children of one topic","href":"/api-reference/help-center/structure/reorder"}]},{"group":"Media","icon":"image","pages":[{"openapi":"post /hc/{id}/media","sidebarTitle":"Upload","title":"Upload media file to help center","href":"/api-reference/help-center/media/upload"},{"openapi":"get /hc/{id}/media","sidebarTitle":"List","title":"List help center media files","href":"/api-reference/help-center/media/list"},{"openapi":"delete /hc/{id}/media/{mediaId}","sidebarTitle":"Delete","title":"Delete help center media file","href":"/api-reference/help-center/media/delete"}]}]},{"group":"AI Actions","pages":[{"title":"AI Actions","icon":"bolt","href":"/api-reference/actions/index"},{"sidebarTitle":"List","openapi":"get /actions","title":"List all actions","href":"/api-reference/actions/list"},{"openapi":"get /actions/{action_id}","sidebarTitle":"Get","title":"Get an action","href":"/api-reference/actions/get"},{"openapi":"post /actions","sidebarTitle":"Create","title":"Create an action","href":"/api-reference/actions/create"},{"openapi":"patch /actions/{action_id}","sidebarTitle":"Update","title":"Update an action","href":"/api-reference/actions/update"},{"openapi":"delete /actions/{action_id}","sidebarTitle":"Delete","title":"Delete an action","href":"/api-reference/actions/delete"},{"openapi":"delete /actions/all","sidebarTitle":"Delete all","title":"Delete all actions","href":"/api-reference/actions/delete_all"},{"openapi":"put /actions/import","sidebarTitle":"Import","title":"Import actions from OpenAPI spec","href":"/api-reference/actions/import"},{"openapi":"get /actions/tags","sidebarTitle":"List tags","title":"List distinct action tags","href":"/api-reference/actions/list_tags"},{"openapi":"post /actions/{operation_id}/invoke","sidebarTitle":"Invoke an action","title":"Invoke an action","href":"/api-reference/actions/invoke-action"}]},{"group":"Autopilot","pages":[{"sidebarTitle":"Get","openapi":"get /autopilot","title":"Get autopilot status","href":"/api-reference/autopilot/get"},{"openapi":"put /autopilot","sidebarTitle":"Update","title":"Enable or disable autopilot for a channel","href":"/api-reference/autopilot/update"},{"openapi":"get /autopilot/prohibited-topics","sidebarTitle":"List prohibited topics","title":"List prohibited topics","href":"/api-reference/autopilot/list-prohibited-topics"},{"openapi":"put /autopilot/prohibited-topics","sidebarTitle":"Replace prohibited topics","title":"Replace prohibited topics","href":"/api-reference/autopilot/update-prohibited-topics"}]},{"group":"Resource Usage","pages":[{"title":"Resource Usage","icon":"chart-simple","href":"/api-reference/resource-usage/index"},{"openapi":"get /resource-usage/{resource_type}","sidebarTitle":"List Usage","title":"List usage counts for all resources of a type","href":"/api-reference/resource-usage/list"},{"openapi":"get /resource-usage/{resource_type}/{resource_id}/usage-summary","sidebarTitle":"Get Usage Summary","title":"Get usage counts for a resource","href":"/api-reference/resource-usage/usage-summary"},{"openapi":"get /resource-usage/{resource_type}/{resource_id}/conversations","sidebarTitle":"List Conversations","title":"List conversations that used a resource","href":"/api-reference/resource-usage/conversations"}]},{"group":"Mini-apps","pages":[{"title":"List mini-apps","sidebarTitle":"List apps","openapi":"get /mini-apps","href":"/api-reference/mini-apps/list"},{"title":"Create a mini-app","sidebarTitle":"Create","openapi":"post /mini-apps","href":"/api-reference/mini-apps/create"},{"title":"Submit a mini-app version","sidebarTitle":"Submit version","openapi":"post /mini-apps/submit","href":"/api-reference/mini-apps/submit"},{"title":"Update mini-app details","sidebarTitle":"Update details","openapi":"patch /mini-apps/{id}","href":"/api-reference/mini-apps/update"},{"title":"Read mini-app source and edit access","sidebarTitle":"Read source","openapi":"get /mini-apps/{id}/source","href":"/api-reference/mini-apps/source"},{"title":"List mini-app tags","sidebarTitle":"List tags","openapi":"get /mini-apps/tags","href":"/api-reference/mini-apps/tags"}]},{"group":"Workflows (Beta)","pages":[{"title":"Workflows (Beta)","icon":"diagram-project","href":"/api-reference/workflows/index"},{"openapi":"get /workflows/definitions","sidebarTitle":"Definitions","title":"[Beta] List available action and trigger types","href":"/api-reference/workflows/definitions"},{"openapi":"post /workflows/validate","sidebarTitle":"Validate","title":"[Beta] Validate a workflow definition","href":"/api-reference/workflows/validate"},{"openapi":"post /workflows","sidebarTitle":"Create","title":"[Beta] Create a workflow","href":"/api-reference/workflows/create"},{"sidebarTitle":"List","openapi":"get /workflows","title":"[Beta] List workflows","href":"/api-reference/workflows/list"},{"openapi":"get /workflows/{workflow_id}","sidebarTitle":"Get","title":"[Beta] Get a workflow","href":"/api-reference/workflows/get"},{"openapi":"get /workflows/{workflow_id}/versions","sidebarTitle":"List versions","title":"[Beta] List the versions of a workflow","href":"/api-reference/workflows/list_versions"},{"openapi":"patch /workflows/{workflow_id}","sidebarTitle":"Update","title":"[Beta] Update a workflow (creates a new version)","href":"/api-reference/workflows/update"},{"openapi":"delete /workflows/{workflow_id}","sidebarTitle":"Delete","title":"[Beta] Delete a workflow","href":"/api-reference/workflows/delete"},{"openapi":"post /workflows/{workflow_id}/activate","sidebarTitle":"Activate","title":"[Beta] Activate a workflow","href":"/api-reference/workflows/activate"},{"openapi":"post /workflows/{workflow_id}/versions/{version}/activate","sidebarTitle":"Activate a version","title":"[Beta] Activate an earlier version of a workflow","href":"/api-reference/workflows/activate_version"},{"openapi":"post /workflows/{workflow_id}/deactivate","sidebarTitle":"Deactivate","title":"[Beta] Deactivate a workflow","href":"/api-reference/workflows/deactivate"},{"openapi":"post /workflows/{workflow_id}/trigger","sidebarTitle":"Trigger","title":"[Beta] Trigger a workflow","href":"/api-reference/workflows/trigger"},{"openapi":"get /workflows/{workflow_id}/runs","sidebarTitle":"List runs","title":"[Beta] List workflow runs","href":"/api-reference/workflows/list_runs"},{"openapi":"get /workflows/{workflow_id}/runs/{run_id}","sidebarTitle":"Get run","title":"[Beta] Get a workflow run","href":"/api-reference/workflows/get_run"},{"openapi":"get /workflows/{workflow_id}/runs/{run_id}/logs","sidebarTitle":"Get run logs","title":"[Beta] Get chronological log entries for a workflow run","href":"/api-reference/workflows/get_run_logs"},{"openapi":"patch /workflows/{workflow_id}/draft","sidebarTitle":"Update a workflow draft in place when possible","title":"[Beta] Update a workflow draft in place when possible","href":"/api-reference/workflows/update-workflow-draft-aware"},{"openapi":"post /workflows/{workflow_id}/invoke","sidebarTitle":"Invoke a workflow","title":"[Beta] Invoke a workflow","href":"/api-reference/workflows/invoke-workflow"},{"openapi":"get /workflows/{workflow_id}/runs/{run_id}/run-steps","sidebarTitle":"Get step-level results for a workflow run","title":"[Beta] Get step-level results for a workflow run","href":"/api-reference/workflows/get-workflow-run-steps"},{"openapi":"post /workflows/{workflow_id}/runs/{run_id}/rerun","sidebarTitle":"Rerun a failed workflow run","title":"[Beta] Re-fire a failed workflow run with the same payload","href":"/api-reference/workflows/rerun-workflow-run"},{"openapi":"post /workflows/{workflow_id}/test","sidebarTitle":"Dry-run a workflow against a synthetic payload","title":"[Beta] Dry-run a workflow against a synthetic payload","href":"/api-reference/workflows/test-workflow"},{"openapi":"post /workflows/{workflow_id}/clone","sidebarTitle":"Clone a workflow into a new inactive draft","title":"[Beta] Clone a workflow into a new inactive draft","href":"/api-reference/workflows/clone-workflow"}]}]},{"group":"Channels","pages":[{"group":"AI Phone Agents","pages":[{"openapi":"post /phone","sidebarTitle":"Create","title":"Create an AI phone agent","href":"/api-reference/phone/create"},{"openapi":"get /phone","sidebarTitle":"List","title":"List AI phone agents","href":"/api-reference/phone/list"},{"openapi":"put /phone/{phone_agent_id}/caller-number","sidebarTitle":"Set caller number","title":"Attach or detach the outbound caller number of a phone agent","href":"/api-reference/phone/set_caller_number"},{"openapi":"get /phone/{phone_agent_id}/draft","sidebarTitle":"Get draft","title":"Get the draft of an AI phone agent","href":"/api-reference/phone/get_draft"},{"openapi":"post /phone/{phone_agent_id}/publish","sidebarTitle":"Publish","title":"Publish an AI phone agent","href":"/api-reference/phone/publish"},{"openapi":"post /phone/{phone_agent_id}/versions/{version}/publish","sidebarTitle":"Publish earlier version","title":"Publish an earlier version of an AI phone agent","href":"/api-reference/phone/publish_version"},{"openapi":"post /phone/{phone_agent_id}/draft/discard","sidebarTitle":"Discard draft","title":"Discard the draft of an AI phone agent","href":"/api-reference/phone/discard_draft"},{"openapi":"get /phone/transfer-destinations","sidebarTitle":"List transfer destinations","title":"List transfer destinations","href":"/api-reference/phone/list_transfer_destinations"},{"openapi":"post /phone/calls/hand-back","sidebarTitle":"Hand back a call","title":"Hand back a transferred call","href":"/api-reference/phone/hand_back_call"},{"openapi":"post /agent-availability/me/wrap-up/ready","sidebarTitle":"Finish wrap-up","title":"Finish your wrap-up for a closed phone session","href":"/api-reference/phone/finish_wrap_up"},{"openapi":"post /phone/outbound-call","sidebarTitle":"Make outbound call","title":"Make an AI phone call","href":"/api-reference/phone/make_outbound_call"},{"openapi":"post /phone/web-calls","sidebarTitle":"Create app voice call","title":"Create an app voice call","href":"/api-reference/phone/create_web_call"},{"openapi":"post /phone/web-calls/{callId}/connect","sidebarTitle":"Connect app voice call","title":"Start a connected app voice call","href":"/api-reference/phone/connect_web_call"},{"openapi":"get /phone/web-calls/{callId}","sidebarTitle":"Get app voice call","title":"Get app voice call status","href":"/api-reference/phone/get_web_call"},{"openapi":"delete /phone/web-calls/{callId}","sidebarTitle":"End app voice call","title":"End an app voice call","href":"/api-reference/phone/end_web_call"},{"openapi":"get /phone/voices","sidebarTitle":"List available voices","title":"List available voices","href":"/api-reference/phone/list-voices"},{"openapi":"get /phone/verified-phone-numbers","sidebarTitle":"List the organization's verified phone numbers","title":"List the organization's verified phone numbers","href":"/api-reference/phone/list-verified-phone-numbers"},{"openapi":"get /phone/{phone_agent_id}/knowledge-sources","sidebarTitle":"Get phone agent knowledge-source tree","title":"Get phone agent knowledge-source tree","href":"/api-reference/phone/get-phone-agent-knowledge-sources"},{"openapi":"put /phone/{phone_agent_id}/knowledge-sources","sidebarTitle":"Update phone agent knowledge sources","title":"Update phone agent knowledge sources","href":"/api-reference/phone/update-phone-agent-knowledge-sources"},{"openapi":"get /phone/{phone_agent_id}/knowledge-sources/items","sidebarTitle":"List knowledge items in a source folder","title":"List knowledge items in a phone agent source folder","href":"/api-reference/phone/list-phone-agent-knowledge-source-items"},{"openapi":"get /phone/{phone_agent_id}/workflows","sidebarTitle":"List workflows for a phone agent","title":"List workflows for a phone agent","href":"/api-reference/phone/get-phone-agent-workflows"},{"openapi":"put /phone/{phone_agent_id}/workflows","sidebarTitle":"Update phone agent workflows","title":"Update phone agent workflows","href":"/api-reference/phone/update-phone-agent-workflows"},{"openapi":"get /phone/{phone_agent_id}","sidebarTitle":"Get an AI phone agent","title":"Get an AI phone agent","href":"/api-reference/phone/get-phone-agent"},{"openapi":"patch /phone/{phone_agent_id}","sidebarTitle":"Update an AI phone agent","title":"Update an AI phone agent","href":"/api-reference/phone/update-phone-agent"},{"openapi":"delete /phone/{phone_agent_id}","sidebarTitle":"Delete an AI phone agent","title":"Delete an AI phone agent","href":"/api-reference/phone/delete-phone-agent"}]},{"group":"Classical IVR","pages":[{"openapi":"get /call-flows/assets","sidebarTitle":"List recordings","title":"List WAV recordings for call flows","href":"/api-reference/call-flows/list-assets"},{"openapi":"post /call-flows/assets","sidebarTitle":"Upload recording","title":"Upload an immutable WAV recording","href":"/api-reference/call-flows/upload-asset"},{"openapi":"put /call-flows/binding","sidebarTitle":"Assign number","title":"Assign an active call flow to a phone number","href":"/api-reference/call-flows/set-binding"}]},{"group":"AI Email","pages":[{"openapi":"post /email","sidebarTitle":"Email API","title":"Send emails","href":"/api-reference/email/email_api"},{"openapi":"put /email/domains","sidebarTitle":"Put domains","title":"Add or update a custom domain for email sending","href":"/api-reference/email/put_domains"},{"openapi":"get /email/domains","sidebarTitle":"Get domains","title":"List all custom domains","href":"/api-reference/email/get_domains"},{"openapi":"patch /email/domains/{domainName}/verify","sidebarTitle":"Patch domains verify","title":"Start verification process for a custom domain","href":"/api-reference/email/patch_domains_verify"},{"openapi":"delete /email/domains/{domainName}","sidebarTitle":"Delete domains","title":"Delete a custom domain","href":"/api-reference/email/delete_domains"},{"openapi":"get /email/channels","sidebarTitle":"List email channels","title":"List email channels","href":"/api-reference/email/get_channels"},{"openapi":"patch /email/channels/{emailChannelId}","sidebarTitle":"Update email channel template","title":"Update an email channel's template","href":"/api-reference/email/patch_channels"}]},{"group":"Email Templates","pages":[{"openapi":"get /email-templates","sidebarTitle":"List email templates","title":"List email templates","href":"/api-reference/email-templates/list-email-templates"},{"openapi":"post /email-templates","sidebarTitle":"Create an email template","title":"Create an email template","href":"/api-reference/email-templates/create-email-template"},{"openapi":"get /email-templates/{id}","sidebarTitle":"Get an email template","title":"Get an email template","href":"/api-reference/email-templates/get-email-template"},{"openapi":"put /email-templates/{id}","sidebarTitle":"Update an email template","title":"Update an email template","href":"/api-reference/email-templates/update-email-template"},{"openapi":"delete /email-templates/{id}","sidebarTitle":"Delete an email template","title":"Delete an email template","href":"/api-reference/email-templates/delete-email-template"},{"openapi":"get /email-templates/{id}/activity","sidebarTitle":"List sends for an email template","title":"List sends for an email template","href":"/api-reference/email-templates/get-email-template-activity"}]},{"group":"AI WhatsApp","pages":[{"openapi":"post /whatsapp/messages","sidebarTitle":"Send message","title":"Send a WhatsApp message","href":"/api-reference/whatsapp/send-message"},{"openapi":"post /whatsapp/send-template","sidebarTitle":"Send template","title":"Send a WhatsApp template","href":"/api-reference/whatsapp/send-template"},{"openapi":"get /whatsapp/templates/catalog","sidebarTitle":"List WhatsApp templates","title":"List WhatsApp templates, flattened for picking one","href":"/api-reference/whatsapp/list-whatsapp-template-catalog"},{"openapi":"get /whatsapp/senders","sidebarTitle":"List WhatsApp sender numbers","title":"List the WhatsApp numbers this organization can send from","href":"/api-reference/whatsapp/list-whatsapp-senders"},{"openapi":"post /whatsapp/templates","sidebarTitle":"Submit a new WhatsApp template for Meta approval","title":"Submit a new WhatsApp template for Meta approval","href":"/api-reference/whatsapp/create-whatsapp-template-draft"},{"openapi":"get /whatsapp/templates/{templateId}","sidebarTitle":"Get template","title":"Get a WhatsApp template","href":"/api-reference/whatsapp/get-template"},{"openapi":"patch /whatsapp/templates/{templateId}","sidebarTitle":"Edit template","title":"Edit a WhatsApp template","href":"/api-reference/whatsapp/update-template"},{"openapi":"delete /whatsapp/templates/{templateId}","sidebarTitle":"Delete template","title":"Delete a WhatsApp template","href":"/api-reference/whatsapp/delete-template"}]},{"group":"AI SMS","pages":[{"title":"SMS","icon":"message-sms","href":"/api-reference/sms/index"},{"openapi":"get /sms/overview","sidebarTitle":"Get overview","title":"Get the organization’s SMS numbers, registrations and delivery problems","href":"/api-reference/sms/get-overview"},{"openapi":"get /sms/pricing","sidebarTitle":"Get pricing","title":"Get what SMS numbers, texts and US registration cost","href":"/api-reference/sms/get-pricing"},{"openapi":"put /sms/channel","sidebarTitle":"Update channel","title":"Pick the number customers text, and turn texts into the inbox on or off","href":"/api-reference/sms/update-channel"},{"openapi":"post /sms/site-check","sidebarTitle":"Check a website","title":"Check a website’s privacy policy, terms and opt-in page for SMS registration","href":"/api-reference/sms/check-website"},{"openapi":"put /sms/registrations","sidebarTitle":"Save registration","title":"Save the answers of a US SMS registration as a draft","href":"/api-reference/sms/save-registration"},{"openapi":"post /sms/registrations/{id}/check","sidebarTitle":"Run the free check","title":"Run the free check on a registration’s saved answers","href":"/api-reference/sms/check-registration"},{"openapi":"post /sms/registrations/{id}/submit","sidebarTitle":"Submit registration","title":"Submit a registration to the carriers","href":"/api-reference/sms/submit-registration"},{"openapi":"post /sms/registrations/{id}/refresh","sidebarTitle":"Refresh status","title":"Ask the carriers for a registration’s latest status","href":"/api-reference/sms/refresh-registration"}]},{"group":"Slack","pages":[{"openapi":"get /slack/connection-status","sidebarTitle":"Get Slack connection status","title":"Get Slack connection status","href":"/api-reference/slack/get-slack-connection-status"},{"openapi":"get /slack/bot-channels","sidebarTitle":"List Slack channels the bot is in","title":"List Slack channels the bot is in","href":"/api-reference/slack/list-slack-bot-channels"},{"openapi":"get /slack/notification-settings","sidebarTitle":"Get Slack notification settings","title":"Get Slack notification settings","href":"/api-reference/slack/get-slack-notification-settings"},{"openapi":"put /slack/notification-settings","sidebarTitle":"Update Slack notification settings","title":"Update Slack notification settings","href":"/api-reference/slack/update-slack-notification-settings"},{"openapi":"get /slack/tag-directory","sidebarTitle":"Get the Slack mention directory","title":"Get the Slack mention directory","href":"/api-reference/slack/get-slack-tag-directory"},{"openapi":"put /slack/tag-directory","sidebarTitle":"Replace the Slack mention directory","title":"Replace the Slack mention directory","href":"/api-reference/slack/update-slack-tag-directory"}]},{"group":"Widget Connections","pages":[{"openapi":"post /widget/connections/{connectionId}/access-token","sidebarTitle":"Retrieve a connection access token","title":"Retrieve a personal connection access token from your backend","href":"/api-reference/widget/get-widget-connection-access-token"},{"openapi":"post /widget/connections/{serverId}/call","sidebarTitle":"Use a user connection from your backend","title":"Use a user connection from your backend","href":"/api-reference/widget/call-widget-connection-tool"}]},{"group":"Connect","pages":[{"title":"Connect API overview","sidebarTitle":"Overview","icon":"arrows-left-right","href":"/api-reference/connect/index"},{"title":"Create a Connect thread","sidebarTitle":"Create thread","api":"POST /connect/threads","href":"/api-reference/connect/create-thread"},{"title":"Get a Connect thread","sidebarTitle":"Get thread","api":"GET /connect/threads/{thread_id}","href":"/api-reference/connect/get-thread"},{"title":"List Connect threads","sidebarTitle":"List threads","api":"GET /connect/threads","href":"/api-reference/connect/list-threads"},{"title":"Update a Connect thread","sidebarTitle":"Update thread","api":"PATCH /connect/threads/{thread_id}","href":"/api-reference/connect/update-thread"},{"title":"Add a Connect participant","sidebarTitle":"Add participant","api":"POST /connect/threads/{thread_id}/participants","href":"/api-reference/connect/add-participant"},{"title":"Remove a Connect participant","sidebarTitle":"Remove participant","api":"DELETE /connect/threads/{thread_id}/participants/{participant_id}","href":"/api-reference/connect/remove-participant"},{"title":"Create a participant token","sidebarTitle":"Create token","api":"POST /connect/threads/{thread_id}/tokens","href":"/api-reference/connect/create-token"},{"title":"Send a Connect message","sidebarTitle":"Send message","api":"POST /connect/threads/{thread_id}/messages","href":"/api-reference/connect/send-message"},{"title":"List Connect messages","sidebarTitle":"List messages","api":"GET /connect/threads/{thread_id}/messages","href":"/api-reference/connect/list-messages"}]}]},{"group":"Outbound","pages":[{"group":"Sequences","pages":[{"title":"Sequences API","sidebarTitle":"Sequences overview","icon":"paper-plane","href":"/api-reference/sequences/index"},{"group":"Sequences","pages":[{"openapi":"post /sequences","sidebarTitle":"Create sequence","title":"Create an outbound sequence, as a draft","href":"/api-reference/sequences/create"},{"openapi":"get /sequences","sidebarTitle":"List sequences","title":"List outbound sequences","href":"/api-reference/sequences/list"},{"openapi":"get /sequences/{sequenceId}","sidebarTitle":"Get sequence","title":"Get an outbound sequence","href":"/api-reference/sequences/get"},{"openapi":"patch /sequences/{sequenceId}","sidebarTitle":"Update sequence","title":"Update a sequence — name, brief, criteria, reply instructions, settings","href":"/api-reference/sequences/update"}]},{"group":"Steps","pages":[{"openapi":"put /sequences/{sequenceId}/steps","sidebarTitle":"Set steps (draft)","title":"Replace the step list of a DRAFT sequence","href":"/api-reference/sequences/set-steps"},{"openapi":"patch /sequences/{sequenceId}/steps","sidebarTitle":"Edit steps","title":"Surgically edit steps — update content/delays, append, remove (any status)","href":"/api-reference/sequences/edit-steps"},{"openapi":"patch /sequences/{sequenceId}/steps/{stepIndex}/delay","sidebarTitle":"Update step delay","title":"Change how long a step waits before it sends","href":"/api-reference/sequences/update-step-delay"},{"openapi":"get /sequences/{sequenceId}/data-keys","sidebarTitle":"Data keys","title":"List the attached-data keys a sequence's people carry","href":"/api-reference/sequences/data-keys"}]},{"group":"People","pages":[{"openapi":"post /sequences/{sequenceId}/contacts","sidebarTitle":"Add contacts","title":"Enroll people into an outbound sequence — returns a per-person outcome","href":"/api-reference/sequences/add-contacts"},{"openapi":"get /sequences/{sequenceId}/contacts","sidebarTitle":"List contacts","title":"List a campaign's people (paginated summary rows)","href":"/api-reference/sequences/list-contacts"},{"openapi":"get /sequences/{sequenceId}/contacts/{contactId}","sidebarTitle":"Get contact","title":"One person's full record: verdicts, qualification, enrichment","href":"/api-reference/sequences/get-contact"},{"openapi":"get /sequences/{sequenceId}/contacts/{contactId}/events","sidebarTitle":"Get contact events","title":"One person's journey ledger — every step outcome, oldest first","href":"/api-reference/sequences/get-contact-events"},{"openapi":"patch /sequences/{sequenceId}/contacts/{contactId}","sidebarTitle":"Update contact","title":"Correct a person's name or the handles the sequence sends to","href":"/api-reference/sequences/update-contact"},{"openapi":"post /sequences/{sequenceId}/contacts/{contactId}/include","sidebarTitle":"Include anyway","title":"Override a below-cutoff judgment (\"include anyway\")","href":"/api-reference/sequences/include-contact"},{"openapi":"post /sequences/{sequenceId}/contacts/{contactId}/skip-step","sidebarTitle":"Skip step for contact","title":"Skip one pending step for a contact","href":"/api-reference/sequences/skip-step"},{"openapi":"post /sequences/{sequenceId}/contacts/{contactId}/continue","sidebarTitle":"Continue after reply","title":"Continue the sequence for a person a reply took out of it","href":"/api-reference/sequences/continue-contact"},{"openapi":"post /sequences/{sequenceId}/contacts/exit","sidebarTitle":"Remove contact","title":"Remove one person from the sequence","href":"/api-reference/sequences/exit-contact"}]},{"group":"Launch","pages":[{"openapi":"get /sequences/{sequenceId}/launch-preview","sidebarTitle":"Launch preview","title":"What launching WOULD do, without doing it","href":"/api-reference/sequences/launch-preview"},{"openapi":"post /sequences/{sequenceId}/launch","sidebarTitle":"Launch sequence","title":"Launch an outbound sequence — arms candidates for sending","href":"/api-reference/sequences/launch"},{"openapi":"post /sequences/{sequenceId}/pause","sidebarTitle":"Pause sequence","title":"Pause an outbound sequence — sending stops now; people keep their place","href":"/api-reference/sequences/pause"},{"openapi":"post /sequences/{sequenceId}/resume","sidebarTitle":"Resume sequence","title":"Resume a paused sequence","href":"/api-reference/sequences/resume"}]},{"group":"Insight","pages":[{"openapi":"get /sequences/{sequenceId}/stats","sidebarTitle":"Get stats","title":"Get an outbound sequence's numbers","href":"/api-reference/sequences/stats"},{"openapi":"get /sequences/number-pool-call-metrics","sidebarTitle":"Pool call metrics","title":"Read per-number metrics for sequence calls made through number pools","href":"/api-reference/sequences/number-pool-call-metrics"},{"openapi":"get /sequences/{sequenceId}/replies","sidebarTitle":"List replies","title":"List the most recent replies to a sequence","href":"/api-reference/sequences/replies"}]},{"group":"Senders","pages":[{"openapi":"get /sequences/{sequenceId}/senders","sidebarTitle":"List senders","title":"List the senders bound to a sequence","href":"/api-reference/sequences/list-senders"},{"openapi":"put /sequences/{sequenceId}/senders","sidebarTitle":"Set senders","title":"Set the senders a sequence may send from (replace-set per channel)","href":"/api-reference/sequences/set-senders"},{"openapi":"get /sequences/email-senders","sidebarTitle":"List email senders","title":"List the mailboxes this org can bind as sequence email senders","href":"/api-reference/sequences/list-email-senders"},{"openapi":"get /sequences/voice-senders","sidebarTitle":"List voice senders","title":"List the phone agents this org can bind as sequence voice senders","href":"/api-reference/sequences/list-voice-senders"},{"openapi":"get /sequences/sms-senders","sidebarTitle":"List SMS senders","title":"List the SMS sender this org can bind for sequence SMS steps","href":"/api-reference/sequences/list-sms-senders"},{"openapi":"get /sequences/voice-trunks","sidebarTitle":"List voice trunks","title":"List the SIP trunks a sequence's Human voice step can call through","href":"/api-reference/sequences/list-voice-trunks"},{"openapi":"get /sequences/{sequenceId}/call-attempts","sidebarTitle":"List call attempts","title":"List a sequence's team calls","href":"/api-reference/sequences/list-call-attempts"}]},{"group":"Qualification","pages":[{"openapi":"post /sequences/{sequenceId}/enrich","sidebarTitle":"Enrich contacts","title":"Enrich scoped people from org data (async run)","href":"/api-reference/sequences/enrich"},{"openapi":"post /sequences/{sequenceId}/judge","sidebarTitle":"Judge contacts","title":"Judge scoped people against criteria (async run)","href":"/api-reference/sequences/judge"},{"openapi":"get /sequences/{sequenceId}/qualification-runs","sidebarTitle":"List qualification runs","title":"List a campaign's enrich/judge runs, latest first","href":"/api-reference/sequences/list-qualification-runs"},{"openapi":"get /sequences/{sequenceId}/qualification-runs/{runId}","sidebarTitle":"Get qualification run","title":"One run: status, live counts, completion aggregates","href":"/api-reference/sequences/get-qualification-run"},{"openapi":"put /sequences/{sequenceId}/columns","sidebarTitle":"Set columns","title":"Set the columns the sequence's People table shows","href":"/api-reference/sequences/set-columns"},{"openapi":"get /sequences/enrichment-catalog","sidebarTitle":"Enrichment catalog","title":"List the enrichment paths a sequence column may project","href":"/api-reference/sequences/enrichment-catalog"}]},{"group":"Audience discovery","pages":[{"openapi":"post /sequences/discovery/search","sidebarTitle":"Discover contacts","title":"Semantic audience discovery — match a natural-language ask against what customers actually said, returning candidate people + evidence","href":"/api-reference/sequences/discover"}]},{"openapi":"get /sequences/{sequenceId}/contacts/{contactId}/steps/{stepIndex}/preview","sidebarTitle":"What one person will get at one step, rendered","title":"What one person will get at one step, rendered","href":"/api-reference/sequences/preview-sequence-step-for-contact"},{"openapi":"put /sequences/{sequenceId}/contacts/{contactId}/steps/{stepIndex}/personalization","sidebarTitle":"Hand-write one step for one person","title":"Hand-write one step for one person","href":"/api-reference/sequences/set-sequence-step-personalization"},{"openapi":"delete /sequences/{sequenceId}/contacts/{contactId}/steps/{stepIndex}/personalization","sidebarTitle":"Remove a person's hand-written step","title":"Remove a person's hand-written step — back to the template","href":"/api-reference/sequences/clear-sequence-step-personalization"},{"openapi":"get /sequences/contacts/{contactId}/sequences","sidebarTitle":"List a contact's sequences","title":"Every sequence a contact is in, across the workspace","href":"/api-reference/sequences/list-contact-sequences"}]},{"group":"Outbound Blocklist","pages":[{"title":"Outbound Blocklist API","sidebarTitle":"Outbound blocklist overview","icon":"ban","href":"/api-reference/outbound-blocklist/index"},{"openapi":"post /outbound/blocklist","sidebarTitle":"Block address","title":"Block an address from outbound contact","href":"/api-reference/outbound-blocklist/block"},{"openapi":"delete /outbound/blocklist","sidebarTitle":"Unblock address","title":"Unblock an address","href":"/api-reference/outbound-blocklist/unblock"},{"openapi":"get /outbound/blocklist/check","sidebarTitle":"Check address","title":"Check whether an address is blocked","href":"/api-reference/outbound-blocklist/check"},{"openapi":"get /outbound/blocklist","sidebarTitle":"List addresses","title":"List blocked addresses","href":"/api-reference/outbound-blocklist/list"}]}]},{"group":"Teams and routing","pages":[{"group":"Users","pages":[{"title":"List organization users","sidebarTitle":"List users","openapi":"get /users","href":"/api-reference/users/list"},{"title":"Get an organization user","sidebarTitle":"Get user","openapi":"get /users/{user_id}","href":"/api-reference/users/get"},{"title":"Deactivate an organization user","sidebarTitle":"Deactivate user","openapi":"post /users/{user_id}/deactivate","href":"/api-reference/users/deactivate"},{"title":"Reactivate an organization user","sidebarTitle":"Reactivate user","openapi":"post /users/{user_id}/reactivate","href":"/api-reference/users/reactivate"},{"openapi":"delete /users/{user_id}","sidebarTitle":"Remove a user from the organization","title":"Remove a user from the organization","href":"/api-reference/users/delete-org-user"},{"openapi":"post /users/batch-delete","sidebarTitle":"Remove multiple users from the organization","title":"Remove multiple users from the organization","href":"/api-reference/users/batch-delete-org-users"},{"openapi":"post /users/invite","sidebarTitle":"Invite a user to the organization","title":"Invite a user to the organization","href":"/api-reference/users/invite-user"}]},{"group":"Roles","pages":[{"title":"List organization roles","sidebarTitle":"List roles","openapi":"get /roles","href":"/api-reference/roles/list"},{"title":"Get an organization role","sidebarTitle":"Get role","openapi":"get /roles/{role_id}","href":"/api-reference/roles/get"}]},{"group":"Teams","pages":[{"title":"Teams","icon":"users","href":"/api-reference/teams/index"},{"openapi":"get /teams","sidebarTitle":"Get all","title":"Get all teams","href":"/api-reference/teams/get_all"},{"openapi":"get /teams/{teamId}","sidebarTitle":"Get","title":"Get specific team","href":"/api-reference/teams/get"},{"openapi":"post /teams","sidebarTitle":"Create","title":"Create new team","href":"/api-reference/teams/create"},{"openapi":"put /teams/{teamId}","sidebarTitle":"Update","title":"Update team","href":"/api-reference/teams/update"},{"openapi":"get /teams/categories","sidebarTitle":"List categories","title":"List team categories","href":"/api-reference/teams/list_categories"},{"openapi":"post /teams/categories","sidebarTitle":"Create category","title":"Create a team category","href":"/api-reference/teams/create_category"},{"openapi":"delete /teams/{teamId}","sidebarTitle":"Delete","title":"Delete team","href":"/api-reference/teams/delete"},{"openapi":"post /teams/{teamId}/users","sidebarTitle":"Add user","title":"Add user to team","href":"/api-reference/teams/add_user"},{"openapi":"delete /teams/{teamId}/users/{userId}","sidebarTitle":"Remove user","title":"Remove user from team","href":"/api-reference/teams/remove_user"},{"openapi":"get /teams/{teamId}/users/available","sidebarTitle":"Get available users in team","title":"Get available users in team","href":"/api-reference/teams/get-available-users-in-team"},{"openapi":"get /teams/{teamId}/users","sidebarTitle":"Get users","title":"Get users in team","href":"/api-reference/teams/get_users"}]},{"group":"Team presets","pages":[{"openapi":"get /team-presets","sidebarTitle":"List presets","title":"List team presets","href":"/api-reference/team-presets/list"},{"openapi":"post /team-presets","sidebarTitle":"Create preset","title":"Create a team preset","href":"/api-reference/team-presets/create"},{"openapi":"patch /team-presets/{presetId}","sidebarTitle":"Update preset","title":"Update a team preset","href":"/api-reference/team-presets/update"},{"openapi":"delete /team-presets/{presetId}","sidebarTitle":"Delete preset","title":"Delete a team preset","href":"/api-reference/team-presets/delete"},{"openapi":"post /team-presets/{presetId}/apply","sidebarTitle":"Apply preset","title":"Apply a team preset to a teammate","href":"/api-reference/team-presets/apply"}]},{"group":"Skills","pages":[{"openapi":"get /skills","sidebarTitle":"List skills","title":"List skills","href":"/api-reference/skills/list-skills"},{"openapi":"post /skills","sidebarTitle":"Create a skill","title":"Create a skill","href":"/api-reference/skills/create-skill"},{"openapi":"get /skills/{skill_id}","sidebarTitle":"Get a skill","title":"Get a skill","href":"/api-reference/skills/get-skill"},{"openapi":"patch /skills/{skill_id}","sidebarTitle":"Update a skill","title":"Update a skill","href":"/api-reference/skills/update-skill"},{"openapi":"delete /skills/{skill_id}","sidebarTitle":"Delete a skill","title":"Delete a skill","href":"/api-reference/skills/delete-skill"},{"openapi":"get /skills/users/{user_id}","sidebarTitle":"Get an agent's skills","title":"Get an agent's skills","href":"/api-reference/skills/get-user-skills"},{"openapi":"put /skills/users/{user_id}","sidebarTitle":"Replace an agent's skills","title":"Replace an agent's skills","href":"/api-reference/skills/set-user-skills"}]},{"group":"Availability Statuses","pages":[{"openapi":"put /agent-availability/{userId}","sidebarTitle":"Update agent availability","title":"Update agent availability","href":"/api-reference/availability-statuses/update-agent-availability"},{"openapi":"get /availability-statuses","sidebarTitle":"List availability statuses","title":"List availability statuses","href":"/api-reference/availability-statuses/list-availability-statuses"},{"openapi":"get /availability-statuses/users","sidebarTitle":"Get users availability statuses","title":"Get users availability statuses (bulk)","href":"/api-reference/availability-statuses/get-users-availability-statuses"},{"openapi":"get /availability-statuses/users/{user_id}","sidebarTitle":"Get user availability status","title":"Get user availability status","href":"/api-reference/availability-statuses/get-user-availability-status"},{"openapi":"put /availability-statuses/users/{user_id}","sidebarTitle":"Apply user availability status","title":"Apply user availability status","href":"/api-reference/availability-statuses/apply-user-availability-status"}]},{"group":"Office Hours","pages":[{"title":"Office hours and holidays","sidebarTitle":"Office Hours","icon":"clock","href":"/api-reference/office-hours/index"},{"openapi":"get /office-hours/default","sidebarTitle":"Get Default","title":"Get default office hours","href":"/api-reference/office-hours/get-default"},{"openapi":"put /office-hours/default","sidebarTitle":"Update Default","title":"Update default office hours","href":"/api-reference/office-hours/update-default"},{"sidebarTitle":"List","openapi":"get /office-hours","title":"List office hours schedules","href":"/api-reference/office-hours/list"},{"openapi":"get /office-hours/{id}","sidebarTitle":"Get","title":"Get an office hours schedule","href":"/api-reference/office-hours/get"},{"sidebarTitle":"Create","openapi":"post /office-hours","title":"Create an office hours schedule","href":"/api-reference/office-hours/create"},{"openapi":"put /office-hours/{id}","sidebarTitle":"Update","title":"Update an office hours schedule","href":"/api-reference/office-hours/update"},{"openapi":"delete /office-hours/{id}","sidebarTitle":"Delete","title":"Delete an office hours schedule","href":"/api-reference/office-hours/delete"}]},{"group":"SLA Policies","pages":[{"title":"SLA policies API","sidebarTitle":"SLA Policies","icon":"file-contract","href":"/api-reference/sla-policies/index"},{"openapi":"get /sla/policies","sidebarTitle":"List","title":null,"href":"/api-reference/sla-policies/list"},{"openapi":"get /sla/policies/{id}","sidebarTitle":"Get","title":null,"href":"/api-reference/sla-policies/get"},{"openapi":"post /sla/policies","sidebarTitle":"Create","title":null,"href":"/api-reference/sla-policies/create"},{"openapi":"put /sla/policies/{id}","sidebarTitle":"Update","title":null,"href":"/api-reference/sla-policies/update"},{"openapi":"delete /sla/policies/{id}","sidebarTitle":"Delete","title":null,"href":"/api-reference/sla-policies/delete"}]}]},{"group":"Analytics","pages":[{"group":"Analytics","pages":[{"openapi":"post /reports/analytics","sidebarTitle":"Run a read-only analytics query","title":"Run a read-only analytics query","href":"/api-reference/analytics/run-analytics-query"}]},{"group":"Impact Report","pages":[{"openapi":"get /impact-report","sidebarTitle":"Get impact report","title":"Get impact report","href":"/api-reference/impact-report/get-impact-report"},{"openapi":"get /impact-report/sankey","sidebarTitle":"Get conversation-flow Sankey","title":"Get conversation-flow Sankey","href":"/api-reference/impact-report/get-conversation-sankey"},{"openapi":"get /impact-report/sankey/tickets","sidebarTitle":"List the tickets behind a Sankey node/link","title":"List the tickets behind a Sankey node/link","href":"/api-reference/impact-report/get-conversation-sankey-tickets"},{"openapi":"get /impact-report/sankey/dimensions","sidebarTitle":"List conversation-flow Sankey dimensions","title":"List conversation-flow Sankey dimensions","href":"/api-reference/impact-report/get-conversation-sankey-dimensions"}]},{"group":"Handoff Analytics","pages":[{"title":"Handoff Analytics","icon":"chart-mixed","href":"/api-reference/handoff-analytics/index"},{"sidebarTitle":"Get Analytics","openapi":"get /handoff-analytics","title":"Get handoff analytics","href":"/api-reference/handoff-analytics/get"},{"sidebarTitle":"List Events","openapi":"get /handoff-analytics/events","title":"List handoff events","href":"/api-reference/handoff-analytics/events"}]},{"group":"SLA Analytics","pages":[{"title":"SLA Analytics","icon":"clock","href":"/api-reference/sla-analytics/index"},{"openapi":"get /sla/analytics","sidebarTitle":"Overview","title":"Get SLA analytics overview","href":"/api-reference/sla-analytics/overview"},{"openapi":"get /sla/analytics/breakdown","sidebarTitle":"Breakdown","title":"Get SLA analytics breakdown","href":"/api-reference/sla-analytics/breakdown"},{"openapi":"get /sla/analytics/trend","sidebarTitle":"Trend","title":"Get SLA analytics trend","href":"/api-reference/sla-analytics/trend"},{"openapi":"get /sla/analytics/breach-heatmap","sidebarTitle":"Breach heatmap","title":"Get SLA breach heatmap","href":"/api-reference/sla-analytics/breach-heatmap"},{"openapi":"get /sla/analytics/phone","sidebarTitle":"Phone answer time","title":"Get phone answer-time analytics","href":"/api-reference/sla-analytics/phone-overview"},{"openapi":"get /sla/analytics/phone/breakdown","sidebarTitle":"Phone answer time breakdown","title":"Get phone answer-time analytics breakdown","href":"/api-reference/sla-analytics/phone-breakdown"},{"openapi":"get /sla/analytics/phone/agents","sidebarTitle":"Phone answer time by agent","title":"Get phone answer analytics per agent","href":"/api-reference/sla-analytics/phone-agents"},{"openapi":"get /sla/analytics/phone/handle-time","sidebarTitle":"Phone handle time","title":"Get phone average handle time","href":"/api-reference/sla-analytics/phone-handle-time"},{"openapi":"get /sla/analytics/phone/handle-time/breakdown","sidebarTitle":"Phone handle time breakdown","title":"Get phone average handle time breakdown","href":"/api-reference/sla-analytics/phone-handle-time-breakdown"},{"openapi":"get /sla/analytics/phone/handles","sidebarTitle":"List phone call handles","title":"List phone call handles","href":"/api-reference/sla-analytics/phone-handles"}]},{"group":"Customer Insights","pages":[{"title":"Customer Insights","icon":"lightbulb","href":"/api-reference/customer-insights/index"},{"sidebarTitle":"Get all","openapi":"post /insights","title":"Get customer insights","href":"/api-reference/customer-insights/get_all"},{"openapi":"get /insights/{id}","title":"Get one","sidebarTitle":"Get a specific customer insight","href":"/api-reference/customer-insights/get"},{"openapi":"post /insights/{id}/resolve","sidebarTitle":"Resolve","title":"Mark an insight as resolved","href":"/api-reference/customer-insights/resolve"},{"sidebarTitle":"Assign","openapi":"post /insights/{id}/assign","title":"Assign insight to a group (team)","href":"/api-reference/customer-insights/assign"},{"group":"Categories","icon":"tag","pages":[{"sidebarTitle":"Get","openapi":"get /insights/categories","title":"Get categories","href":"/api-reference/customer-insights/categories/get"}]},{"openapi":"post /insights/categories","sidebarTitle":"Create a category","title":"Create a category","href":"/api-reference/customer-insights/create-category"},{"openapi":"get /insights/categories/usage","sidebarTitle":"Get category usage","title":"Get category usage","href":"/api-reference/customer-insights/get-category-usage"},{"openapi":"get /insights/settings","sidebarTitle":"Get VOC settings","title":"Get VOC settings","href":"/api-reference/customer-insights/get-voc-settings"},{"openapi":"put /insights/settings","sidebarTitle":"Update VOC settings","title":"Update VOC settings","href":"/api-reference/customer-insights/update-voc-settings"},{"openapi":"put /insights/categories/{categoryId}","sidebarTitle":"Update a category","title":"Update a category","href":"/api-reference/customer-insights/update-category"},{"openapi":"post /insights/categories/approve","sidebarTitle":"Approve a suggested category","title":"Approve a suggested category","href":"/api-reference/customer-insights/approve-category"},{"openapi":"post /insights/categories/reject","sidebarTitle":"Reject a suggested category","title":"Reject a suggested category","href":"/api-reference/customer-insights/reject-category"},{"openapi":"post /insights/{id}/archive","sidebarTitle":"Archive a customer insight","title":"Archive a customer insight","href":"/api-reference/customer-insights/archive-insight"},{"openapi":"post /insights/{id}/unarchive","sidebarTitle":"Unarchive a customer insight","title":"Unarchive a customer insight","href":"/api-reference/customer-insights/unarchive-insight"}]},{"group":"Partner Analytics","pages":[{"openapi":"get /partner-analytics/orgs","sidebarTitle":"List connected organizations","title":"List the connected orgs of the calling partner admin org","href":"/api-reference/partner-analytics/list-partner-orgs"},{"openapi":"get /partner-analytics/orgs/search","sidebarTitle":"Search connected orgs with health signals","title":"Search connected orgs with health signals (paginated)","href":"/api-reference/partner-analytics/search-partner-orgs"},{"openapi":"post /partner-analytics/query","sidebarTitle":"Run a partner analytics query","title":"Run a read-only analytics query across the partner’s connected orgs","href":"/api-reference/partner-analytics/run-partner-analytics-query"}]}]},{"group":"Organization","pages":[{"group":"Organization","pages":[{"title":"Organization","icon":"building","href":"/api-reference/organization/index"},{"openapi":"get /org","sidebarTitle":"Get","title":"Get current organization","href":"/api-reference/organization/get"},{"openapi":"patch /org","sidebarTitle":"Update","title":"Update current organization","href":"/api-reference/organization/update"}]},{"group":"Secrets","pages":[{"title":"Secrets","icon":"key","href":"/api-reference/secrets/index"},{"openapi":"post /secrets","sidebarTitle":"Create","title":"Create a secret","href":"/api-reference/secrets/create"},{"openapi":"put /secrets","sidebarTitle":"Upsert","title":"Create or replace a secret","href":"/api-reference/secrets/upsert"},{"openapi":"get /secret-keys","sidebarTitle":"List names","title":"List secret names","href":"/api-reference/secrets/list-names"}]},{"group":"Audit Logs","pages":[{"title":"Audit Logs API","sidebarTitle":"Overview","icon":"clipboard-list","href":"/api-reference/audit-logs/index"},{"openapi":"get /audit-logs","sidebarTitle":"List","title":"List audit logs","href":"/api-reference/audit-logs/list"}]}]},{"group":"Integrations","pages":[{"group":"Zendesk Integration","pages":[{"title":"Zendesk Integration","icon":"ticket","href":"/api-reference/integrations/zendesk/index"},{"sidebarTitle":"Get settings","openapi":"get /integrations/zendesk/settings","title":"Get Zendesk integration settings","href":"/api-reference/integrations/zendesk/get_settings"},{"sidebarTitle":"Update settings","openapi":"patch /integrations/zendesk/settings","title":"Update Zendesk integration settings","href":"/api-reference/integrations/zendesk/update_settings"},{"sidebarTitle":"List groups","openapi":"get /integrations/zendesk/groups","title":"List Zendesk groups","href":"/api-reference/integrations/zendesk/list_groups"}]},{"group":"Salesforce Integration","pages":[{"title":"Salesforce Integration","icon":"salesforce","href":"/api-reference/integrations/salesforce/index"},{"sidebarTitle":"Get settings","openapi":"get /integrations/salesforce/settings","title":"Get Salesforce integration settings","href":"/api-reference/integrations/salesforce/get_settings"},{"sidebarTitle":"Update settings","openapi":"patch /integrations/salesforce/settings","title":"Update Salesforce integration settings","href":"/api-reference/integrations/salesforce/update_settings"},{"sidebarTitle":"List org-wide addresses","openapi":"get /integrations/salesforce/org-wide-addresses","title":"List Salesforce org-wide email addresses","href":"/api-reference/integrations/salesforce/list_org_wide_addresses"},{"openapi":"get /salesforce/ai-reply-templates","sidebarTitle":"List AI reply templates","title":"List AI reply templates","href":"/api-reference/integrations/salesforce/list-salesforce-ai-reply-templates"},{"openapi":"post /salesforce/ai-reply-templates","sidebarTitle":"Create an AI reply template","title":"Create an AI reply template","href":"/api-reference/integrations/salesforce/create-salesforce-ai-reply-template"},{"openapi":"patch /salesforce/ai-reply-templates/{id}","sidebarTitle":"Update an AI reply template","title":"Update an AI reply template","href":"/api-reference/integrations/salesforce/update-salesforce-ai-reply-template"},{"openapi":"delete /salesforce/ai-reply-templates/{id}","sidebarTitle":"Delete an AI reply template","title":"Delete an AI reply template","href":"/api-reference/integrations/salesforce/delete-salesforce-ai-reply-template"},{"openapi":"post /salesforce/ai-reply-templates/preview","sidebarTitle":"Preview an AI reply template","title":"Preview an AI reply template","href":"/api-reference/integrations/salesforce/preview-salesforce-ai-reply-template"}]},{"group":"Salesforce CRM","pages":[{"openapi":"get /salesforce-crm/connection/status","sidebarTitle":"Get Salesforce CRM connection status","title":"Get Salesforce CRM connection status","href":"/api-reference/integrations/salesforce-crm/get-salesforce-crm-connection-status"},{"openapi":"get /salesforce-crm/contacts/{contactId}","sidebarTitle":"Get a contact's Salesforce CRM panel","title":"Get a contact's Salesforce CRM panel","href":"/api-reference/integrations/salesforce-crm/get-salesforce-crm-contact"},{"openapi":"get /salesforce-crm/contacts","sidebarTitle":"List cached Salesforce CRM records","title":"List cached Salesforce CRM records","href":"/api-reference/integrations/salesforce-crm/list-salesforce-crm-contacts"},{"openapi":"get /salesforce-crm/contacts/search","sidebarTitle":"Search cached Salesforce CRM records","title":"Search cached Salesforce CRM records","href":"/api-reference/integrations/salesforce-crm/search-salesforce-crm-contacts"}]},{"group":"Salesforce MIAW","pages":[{"title":"Salesforce MIAW","icon":"salesforce","href":"/api-reference/salesforce-miaw/index"},{"openapi":"post /salesforce/miaw/webhook","sidebarTitle":"Webhook","title":null,"href":"/api-reference/salesforce-miaw/webhook"}]},{"group":"HubSpot Integration","pages":[{"title":"HubSpot Integration","icon":"hubspot","href":"/api-reference/integrations/hubspot/index"},{"sidebarTitle":"Get settings","openapi":"get /integrations/hubspot/settings","title":"Get HubSpot integration settings","href":"/api-reference/integrations/hubspot/get_settings"},{"sidebarTitle":"Update settings","openapi":"patch /integrations/hubspot/settings","title":"Update HubSpot integration settings","href":"/api-reference/integrations/hubspot/update_settings"},{"sidebarTitle":"List users","openapi":"get /integrations/hubspot/owners","title":"List HubSpot users","href":"/api-reference/integrations/hubspot/list_owners"}]},{"group":"Intercom Integration","pages":[{"title":"Intercom Integration","icon":"comments","href":"/api-reference/integrations/intercom/index"},{"sidebarTitle":"Get settings","openapi":"get /integrations/intercom/settings","title":"Get Intercom settings","href":"/api-reference/integrations/intercom/get_settings"},{"sidebarTitle":"Update settings","openapi":"patch /integrations/intercom/settings","title":"Update Intercom settings","href":"/api-reference/integrations/intercom/update_settings"},{"sidebarTitle":"List admins","openapi":"get /integrations/intercom/admins","title":"List Intercom admins","href":"/api-reference/integrations/intercom/list_admins"},{"sidebarTitle":"List teams","openapi":"get /integrations/intercom/teams","title":"List Intercom teams","href":"/api-reference/integrations/intercom/list_teams"}]},{"group":"Front Integration","pages":[{"title":"Front Integration","icon":"inbox","href":"/api-reference/integrations/front/index"},{"sidebarTitle":"Get settings","openapi":"get /integrations/front/settings","title":"Get Front integration settings","href":"/api-reference/integrations/front/get_settings"},{"sidebarTitle":"Update settings","openapi":"patch /integrations/front/settings","title":"Update Front integration settings","href":"/api-reference/integrations/front/update_settings"},{"sidebarTitle":"List teammates","openapi":"get /integrations/front/teammates","title":"List Front teammates","href":"/api-reference/integrations/front/list_teammates"},{"sidebarTitle":"List inboxes","openapi":"get /integrations/front/inboxes","title":"List Front inboxes","href":"/api-reference/integrations/front/list_inboxes"},{"sidebarTitle":"List signatures","openapi":"get /integrations/front/signatures","title":"List Front signatures","href":"/api-reference/integrations/front/list_signatures"}]},{"group":"Freshdesk Integration","pages":[{"title":"Freshdesk Integration","icon":"ticket","href":"/api-reference/integrations/freshdesk/index"},{"sidebarTitle":"Get settings","openapi":"get /integrations/freshdesk/settings","title":"Get Freshdesk settings","href":"/api-reference/integrations/freshdesk/get_settings"},{"sidebarTitle":"Update settings","openapi":"patch /integrations/freshdesk/settings","title":"Update Freshdesk settings","href":"/api-reference/integrations/freshdesk/update_settings"},{"sidebarTitle":"List groups","openapi":"get /integrations/freshdesk/groups","title":"List Freshdesk groups","href":"/api-reference/integrations/freshdesk/list_groups"},{"sidebarTitle":"List agents","openapi":"get /integrations/freshdesk/agents","title":"List Freshdesk agents","href":"/api-reference/integrations/freshdesk/list_agents"}]},{"group":"Freshchat Integration","pages":[{"title":"Freshchat Integration","icon":"message","href":"/api-reference/integrations/freshchat/index"},{"sidebarTitle":"Get settings","openapi":"get /integrations/freshchat/settings","title":"Get Freshchat settings","href":"/api-reference/integrations/freshchat/get_settings"},{"sidebarTitle":"Update settings","openapi":"patch /integrations/freshchat/settings","title":"Update Freshchat settings","href":"/api-reference/integrations/freshchat/update_settings"},{"sidebarTitle":"List groups","openapi":"get /integrations/freshchat/groups","title":"List Freshchat groups","href":"/api-reference/integrations/freshchat/list_groups"}]},{"group":"Gorgias Integration","pages":[{"title":"Gorgias Integration","icon":"ticket","href":"/api-reference/integrations/gorgias/index"},{"sidebarTitle":"Get settings","openapi":"get /integrations/gorgias/settings","title":"Get Gorgias settings","href":"/api-reference/integrations/gorgias/get_settings"},{"sidebarTitle":"Update settings","openapi":"patch /integrations/gorgias/settings","title":"Update Gorgias settings","href":"/api-reference/integrations/gorgias/update_settings"}]},{"group":"Genesys Cloud Integration","pages":[{"title":"Genesys Cloud Integration","icon":"headset","href":"/api-reference/integrations/genesys/index"},{"sidebarTitle":"Get settings","openapi":"get /integrations/genesys/settings","title":"Get Genesys Cloud settings","href":"/api-reference/integrations/genesys/get_settings"},{"sidebarTitle":"Update settings","openapi":"patch /integrations/genesys/settings","title":"Update Genesys Cloud handoff settings","href":"/api-reference/integrations/genesys/update_settings"},{"sidebarTitle":"List queues","openapi":"get /integrations/genesys/queues","title":"List Genesys Cloud queues","href":"/api-reference/integrations/genesys/list_queues"},{"sidebarTitle":"Get health","openapi":"get /integrations/genesys/health","title":"Get Genesys Cloud health","href":"/api-reference/integrations/genesys/get_health"}]},{"group":"Dynamics 365 Integration","pages":[{"title":"Dynamics 365 Integration","icon":"building","href":"/api-reference/integrations/dynamics365/index"},{"sidebarTitle":"Get settings","openapi":"get /integrations/dynamics365/settings","title":"Get Dynamics 365 integration settings","href":"/api-reference/integrations/dynamics365/get_settings"},{"sidebarTitle":"Update settings","openapi":"patch /integrations/dynamics365/settings","title":"Update Dynamics 365 integration settings","href":"/api-reference/integrations/dynamics365/update_settings"},{"sidebarTitle":"List queues","openapi":"get /integrations/dynamics365/queues","title":"List Dynamics 365 queues","href":"/api-reference/integrations/dynamics365/list_queues"},{"sidebarTitle":"List users","openapi":"get /integrations/dynamics365/owners","title":"List Dynamics 365 users","href":"/api-reference/integrations/dynamics365/list_owners"}]},{"group":"Twilio Flex Integration","pages":[{"title":"Twilio Flex Integration","icon":"headset","href":"/api-reference/integrations/twilio-flex/index"},{"sidebarTitle":"Get settings","openapi":"get /integrations/twilio-flex/settings","title":"Get Twilio Flex integration settings","href":"/api-reference/integrations/twilio-flex/get_settings"},{"sidebarTitle":"Update settings","openapi":"patch /integrations/twilio-flex/settings","title":"Update Twilio Flex integration settings","href":"/api-reference/integrations/twilio-flex/update_settings"},{"sidebarTitle":"List task attributes","openapi":"get /integrations/twilio-flex/task-attributes","title":"List Twilio Flex task attribute names","href":"/api-reference/integrations/twilio-flex/list_task_attributes"}]},{"group":"Infobip Integration","pages":[{"title":"Infobip Integration","icon":"comments","href":"/api-reference/integrations/infobip/index"},{"sidebarTitle":"Get settings","openapi":"get /integrations/infobip/settings","title":"Get Infobip integration settings","href":"/api-reference/integrations/infobip/get_settings"},{"sidebarTitle":"Update settings","openapi":"patch /integrations/infobip/settings","title":"Update Infobip integration settings","href":"/api-reference/integrations/infobip/update_settings"},{"sidebarTitle":"List agents","openapi":"get /integrations/infobip/agents","title":"List Infobip agents","href":"/api-reference/integrations/infobip/list_agents"},{"sidebarTitle":"List queues","openapi":"get /integrations/infobip/queues","title":"List Infobip queues","href":"/api-reference/integrations/infobip/list_queues"}]}]}]}]},"basePath":"","title":"Update an AI suggestion - OpenCX Docs","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}