Read the macro settings: the languages macros are translated into, how many can be chosen, the supported languages, and the suggestions switch.
translation_languages is in the order the languages were chosen; an empty list means macro translation is off, which is the default. suggestions_enabled is the workspace switch for suggested macros. It is read-only in the API.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Open.cx 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":""},"chroma":{"liveDeploymentHistoryId":"6ad4ff56126aad4f2ebbb576","collectionId":"134807d3-733f-41bb-9bea-8d4b267c2fff","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad4ff56126aad4f2ebbb576"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{},"buildId":"6ad4ff56126aad4f2ebbb576","clientVersion":"0.0.3883","searchFilterCounts":[{"language":"default","tag":"API Reference","count":318},{"language":"default","tag":"Integrations","count":113},{"language":"default","tag":"Ticketing Systems","count":100},{"language":"default","tag":"Build Agents","count":63},{"language":"default","tag":"Agent Training","count":53},{"language":"default","tag":"Help Center","count":45},{"language":"default","tag":"Sequences","count":39},{"language":"default","tag":"Channels","count":37},{"language":"default","tag":"Setup Integration","count":32},{"language":"default","tag":"Main Knowledge Sources","count":30}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","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":"editor-v7-file-tree","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-branches-v2-autocommit","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2","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":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"teamspace","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","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":"byok-sep-25","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":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"client-snapshot-docs-config","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}],"isAtlas":false,"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"@keyframes orbit{0%{transform:rotate(calc(var(--angle)*1deg)) translateY(calc(var(--orbit-radius)*-1px)) rotate(calc(var(--angle)*-1deg))}to{transform:rotate(calc(var(--angle)*1deg + 360deg)) translateY(calc(var(--orbit-radius)*-1px)) rotate(calc(var(--angle)*-1deg - 360deg))}}@keyframes docs-footer-status-pulse{0%,to{box-shadow:0 0 0 0 rgba(16,185,129,.55)}50%{box-shadow:0 0 0 5px transparent}}: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-group .card,.card-group card,card,card-group card{border-radius:var(--radius-3xl)}#search-bar-entry,#topbar-cta-button>a,#topbar-cta-button>a>span.absolute,.accordion,.accordion-group .accordion,.callout,.zendesk-flow .zendesk-flow-frame,[data-accordion-item],[data-accordion],accordion,accordion-group accordion,callout,div[class*=language-],div[class*=language-] pre,figure.shiki,pre,pre.shiki,pre>code{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:linear-gradient(180deg, rgba(10, 10, 10, 0.04), transparent 48%),\n var(--docs-context-bg);--docs-context-trigger-bg-hover:linear-gradient(180deg, rgba(10, 10, 10, 0.07), transparent 52%),\n var(--docs-context-bg-hover);--docs-context-trigger-shadow:inset 0 1px 0 rgba(255, 255, 255, 0.9),\n 0 1px 2px rgba(15, 23, 42, 0.04);--docs-context-menu-bg: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: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:linear-gradient(180deg, rgba(255, 255, 255, 0.06), transparent 42%),\n var(--docs-context-bg);--docs-context-trigger-bg-hover:linear-gradient(180deg, rgba(255, 255, 255, 0.1), transparent 48%),\n var(--docs-context-bg-hover);--docs-context-trigger-shadow: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: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: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);--primary:250 250 250;--primary-light:245 245 245;--primary-dark:10 10 10}#page-context-menu button[aria-label='More actions'],#page-context-menu-button{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[aria-label='More actions'] svg,#page-context-menu-button svg,body [data-radix-popper-content-wrapper] [role=menuitem] svg{color:var(--docs-context-accent)!important}#page-context-menu button[aria-label='More actions']:hover,#page-context-menu button[aria-label='More actions'][data-state=open],#page-context-menu-button:hover{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] [class*=text-gray],body [data-radix-popper-content-wrapper] [role=menuitem] [class*=text-slate],body [data-radix-popper-content-wrapper] [role=menuitem] [class*=text-white],body [data-radix-popper-content-wrapper] [role=menuitem] [class*=text-zinc],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 *,#sidebar-content,#sidebar-content *{scrollbar-color:rgba(113,113,122,.4) transparent}#sidebar ::-webkit-scrollbar,#sidebar-content ::-webkit-scrollbar{width:8px;background:0 0}#sidebar ::-webkit-scrollbar-corner,#sidebar ::-webkit-scrollbar-track,#sidebar-content ::-webkit-scrollbar-corner,#sidebar-content ::-webkit-scrollbar-track{background:0 0}#sidebar ::-webkit-scrollbar-thumb,#sidebar-content ::-webkit-scrollbar-thumb{background-color:rgba(113,113,122,.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,.7)}html.dark #sidebar,html.dark #sidebar *,html.dark #sidebar-content,html.dark #sidebar-content *{scrollbar-color:rgba(161,161,170,.35) transparent}html.dark #sidebar ::-webkit-scrollbar-thumb,html.dark #sidebar-content ::-webkit-scrollbar-thumb{background-color:rgba(161,161,170,.35)}html.dark #sidebar ::-webkit-scrollbar-thumb:hover,html.dark #sidebar-content ::-webkit-scrollbar-thumb:hover{background-color:rgba(161,161,170,.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/claude.svg'],html.dark #sidebar img[src*='/images/mcp/cursor.svg'],html.dark #sidebar img[src*='/images/mcp/windsurf.svg'],html.dark #sidebar img[src*='/images/mcp/zed.svg']{filter:invert(1) brightness(.92)}#navbar{box-shadow:none!important;row-gap:.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:not(.dark) #search-bar-entry{background-color:#fff!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,.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,.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,html.dark #topbar-cta-button>a svg{color:#0a0a0a!important}.nav-tabs-item>span>svg:first-child,.nav-tabs-item>svg{display:none!important}.toc-item{padding-left:12px!important;border-left:2px solid rgba(148,163,184,.22)!important;transition:border-color .18s ease,color .18s ease}html.dark .toc-item{border-left-color:rgba(148,163,184,.2)!important}.toc-item:hover{border-left-color:rgba(10,10,10,.45)!important}html.dark .toc-item:hover{border-left-color:rgba(250,250,250,.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 img[src*='logo.svg'],#navbar .h-16 img[src*=logo-light]{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/.07) 1px,transparent 1px),linear-gradient(to bottom,rgb(0 0 0/.07) 1px,transparent 1px);background-size:16px 16px;background-position:center center;-webkit-mask-image:radial-gradient(72% 72% at 50% 50%,#000 0,#000 38%,transparent 82%);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/.08) 1px,transparent 1px),linear-gradient(to bottom,rgb(255 255 255/.08) 1px,transparent 1px)}.animate-orbit{animation:orbit var(--duration) linear infinite}.zendesk-flow-frame{background-image:radial-gradient(ellipse 80% 50% at 50% 50%,rgb(34 197 94/.04),transparent 70%)}html.dark .zendesk-flow-frame{background-image:radial-gradient(ellipse 80% 50% at 50% 50%,rgb(34 197 94/.06),transparent 70%)}.zendesk-flow-grid{background-image:linear-gradient(to right,rgb(0 0 0/.05) 1px,transparent 1px),linear-gradient(to bottom,rgb(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/.05) 1px,transparent 1px),linear-gradient(to bottom,rgb(255 255 255/.05) 1px,transparent 1px)}#footer,.chat-assistant-floating-input,[class*=chat-assistant-floating]{display:none!important}.docs-footer{margin-top:5rem;padding-top:3rem;padding-bottom:1.5rem;border-top:1px solid rgba(228,228,231,.7);font-size:.875rem;color:rgb(82 82 91);line-height:1.5}html.dark .docs-footer{border-top-color:rgba(63,63,70,.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,.55)}html.dark .docs-footer__top{border-bottom-color:rgba(63,63,70,.25)}@media (min-width:768px){.docs-footer__top{flex-direction:row;gap:3rem}}.docs-footer__brand{display:flex;flex-direction:column;gap:.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,html.dark .docs-footer__logo--light{display:none}html.dark .docs-footer__logo--dark{display:inline-block}.docs-footer__desc{margin:.25rem 0 0;font-size:.8125rem;line-height:1.55;color:rgb(63 63 70)}html.dark .docs-footer__desc{color:rgb(212 212 216)}.docs-footer__label{margin:.75rem 0 .25rem;font-size:.6875rem;font-weight:600;letter-spacing:.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:.875rem;align-items:center}.docs-footer__socials a{display:inline-flex;align-items:center;justify-content:center;color:rgb(24 24 27);transition:opacity .15s ease}.docs-footer__socials a:hover{opacity:.65}html.dark .docs-footer__col-header,html.dark .docs-footer__socials a{color:rgb(244 244 245)}html.dark .docs-footer__socials a:hover{opacity:.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:.5rem}.docs-footer__col-header{margin:0 0 .5rem;font-size:.8125rem;font-weight:700!important;color:rgb(24 24 27)}.docs-footer__col a{font-size:.8125rem;color:rgb(63 63 70);text-decoration:none;transition:color .15s ease}.docs-footer__col a:hover,.docs-footer__status:hover{color:rgb(24 24 27)}html.dark .docs-footer__col a{color:rgb(212 212 216)}html.dark .docs-footer__col a:hover,html.dark .docs-footer__status:hover{color:rgb(244 244 245)}.docs-footer__bottom{display:flex;flex-direction:column;align-items:flex-start;gap:.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:.75rem;color:rgb(82 82 91)}html.dark .docs-footer__copy,html.dark .docs-footer__status{color:rgb(161 161 170)}.docs-footer__status{display:inline-flex;align-items:center;gap:.5rem;font-size:.6875rem;font-weight:600;letter-spacing:.1em;text-transform:uppercase;color:rgb(82 82 91);text-decoration:none;transition:color .15s ease}.docs-footer__status-dot{display:inline-block;flex-shrink:0;width:.5rem;height:.5rem;background-color:#10b981;border-radius:var(--radius-full);box-shadow:0 0 0 0 rgba(16,185,129,.55);animation:docs-footer-status-pulse 2.4s ease-in-out infinite}@media (prefers-reduced-motion:reduce){.docs-footer__status-dot{animation:none;box-shadow:0 0 0 3px rgba(16,185,129,.25)}}#pagination{margin-top:3rem;padding-top:2rem;border-top:1px solid rgba(228,228,231,.8)}html.dark #pagination,html.dark #table-of-contents-layout .feedback-toolbar{border-top-color:rgba(63,63,70,.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,.8)}#table-of-contents-layout .feedback-toolbar>div{flex-direction:column;align-items:flex-start;gap:.75rem}#table-of-contents-layout .feedback-toolbar p{white-space:normal}"}],"page":{"pagePath":"api-reference/macros/get-settings","slug":"/api-reference/macros/get-settings","pageMetadata":{"openapi":"get /macros/settings","sidebarTitle":"Get settings","description":"Read the macro settings: the languages macros are translated into, how many can be chosen, the supported languages, and the suggestions switch.","keywords":["macros","macro settings","macro translation languages","translate macros","supported languages","suggested macros switch","macros api","rest api","opencx api","api reference"],"title":null,"href":"/api-reference/macros/get-settings"},"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: \"Read the macro settings: the languages macros are translated into, how many can be chosen, the supported languages, and the suggestions switch.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_components.p,{children:[_jsx(_components.code,{children:`translation_languages`}),` is in the order the languages were chosen; an empty list means macro translation is off, which is the default. `,_jsx(_components.code,{children:`suggestions_enabled`}),` is the workspace switch for suggested macros. It is read-only in the API.`]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"openapi":"get /macros/settings","sidebarTitle":"Get settings","description":"Read the macro settings: the languages macros are translated into, how many can be chosen, the supported languages, and the suggestions switch.","keywords":["macros","macro settings","macro translation languages","translate macros","supported languages","suggested macros switch","macros api","rest api","opencx api","api reference"],"title":null,"href":"/api-reference/macros/get-settings"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/openchat/671ce9e295bc0bed/docs-footer.js","/_mintlify/custom/openchat/5e08dc26b4af039b/opencx-widget.js","/_mintlify/custom/openchat/b138b1492ac22a58/docs-feedback.js"],"subdomain":"openchat","siteName":"Open.cx Docs","title":"Get settings - Open.cx Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-18T17:18:24.741Z","originalFileLocation":"api-reference/macros/get-settings.mdx"},"headHtml":"\u003cmeta data-mint-head name=\"description\" content=\"Read the macro settings: the languages macros are translated into, how many can be chosen, the supported languages, and the suggestions switch.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Open.cx 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=\"Get settings - Open.cx Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Read the macro settings: the languages macros are translated into, how many can be chosen, the supported languages, and the suggestions switch.\">\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/macros/get-settings\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get settings - Open.cx Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Read the macro settings: the languages macros are translated into, how many can be chosen, the supported languages, and the suggestions switch.\">\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=\"Open.cx Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0A0A0A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.open.cx/api-reference/macros/get-settings\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/macros/get-settings.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.open.cx/#organization\",\"name\":\"Open.cx 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\":\"Open.cx Docs\",\"url\":\"https://docs.open.cx\",\"publisher\":{\"@id\":\"https://docs.open.cx/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.open.cx/api-reference/macros/get-settings#webpage\",\"url\":\"https://docs.open.cx/api-reference/macros/get-settings\",\"name\":\"Get settings\",\"description\":\"Read the macro settings: the languages macros are translated into, how many can be chosen, the supported languages, and the suggestions switch.\",\"dateModified\":\"2026-10-18T17:18:24.741Z\",\"isPartOf\":{\"@id\":\"https://docs.open.cx#website\"},\"breadcrumb\":{\"@id\":\"https://docs.open.cx/api-reference/macros/get-settings#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.open.cx/api-reference/macros/get-settings#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Macros\",\"item\":\"https://docs.open.cx/api-reference/macros/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get settings\",\"item\":\"https://docs.open.cx/api-reference/macros/get-settings\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.open.cx/api-reference/macros/get-settings#apireference\",\"headline\":\"Get settings\",\"name\":\"Get settings\",\"description\":\"Read the macro settings: the languages macros are translated into, how many can be chosen, the supported languages, and the suggestions switch.\",\"url\":\"https://docs.open.cx/api-reference/macros/get-settings\",\"mainEntityOfPage\":{\"@id\":\"https://docs.open.cx/api-reference/macros/get-settings#webpage\"},\"dateModified\":\"2026-10-18T17:18:24.741Z\",\"keywords\":\"macros, macro settings, macro translation languages, translate macros, supported languages, suggested macros switch, macros api, rest api, opencx api, api reference\",\"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\":\"Open.cx Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Open.cx Docs","nav":{"global":null,"tabs":[{"tab":"Get Started","icon":"book-open","groups":[{"group":"Get Started","pages":[{"title":"OpenCX Documentation","sidebarTitle":"Welcome","icon":"hand-wave","mode":"wide","href":"/welcome"},{"title":"Quickstart","icon":"rocket","href":"/quickstart"},{"title":"Organization creation and environments","sidebarTitle":"Organizations","icon":"building","href":"/organizations"},{"title":"Manage teams and categories","sidebarTitle":"Teams","icon":"users","href":"/teams"},{"title":"Billing projections, invoice history, and payment methods","sidebarTitle":"Billing","icon":"credit-card","href":"/billing"},{"title":"Plan your rollout","sidebarTitle":"Plan your rollout","icon":"compass","href":"/plan-your-rollout"},{"title":"How OpenCX Works","icon":"diagram-project","href":"/how-opencx-works"},{"title":"Architecture overview","sidebarTitle":"Architecture overview","icon":"sitemap","href":"/architecture-overview"},{"title":"Core Concepts","icon":"book","href":"/core-concepts"},{"title":"Changelog","icon":"book-open","href":"/changelog"}]}]},{"tab":"Build Agents","icon":"robot","groups":[{"group":"Overview","pages":[{"title":"Build Agents get started","sidebarTitle":"Get Started","icon":"rocket","href":"/build-agents/get-started"}]},{"group":"AI Chat Widget","pages":[{"title":"Widget overview","sidebarTitle":"Overview","icon":"messages","href":"/widget/introduction"},{"title":"Playground","icon":"play","mode":"wide","href":"/widget/playground"},{"group":"Setup Channel","icon":"gear","pages":[{"title":"Install Widget","icon":"plug","href":"/widget/install-widget"},{"title":"Widget v5 Companion mode","sidebarTitle":"Companion mode","icon":"sparkles","href":"/widget/companion-mode"},{"title":"OpenCX widget AI coding skills","sidebarTitle":"AI coding skills","icon":"terminal","href":"/widget/agent-skills"},{"title":"Migrate the widget from v4 to v5","sidebarTitle":"Migrate to v5","icon":"arrow-up","href":"/widget/migrate-to-v5"},{"title":"Mobile Support","icon":"phone","href":"/widget/native-mobile"},{"title":"Widget configuration","sidebarTitle":"Configuration","icon":"gear","href":"/widget/configuration"},{"title":"Authentication","icon":"shield-check","href":"/widget/authentication"},{"title":"Widget connections and approvals","sidebarTitle":"Connections","icon":"plug","href":"/widget/connections"},{"title":"Conversation Sessions","icon":"route","href":"/widget/conversation-sessions"},{"title":"Configuration reference","sidebarTitle":"Reference","icon":"code","href":"/widget/configuration-reference"}]},{"group":"Components","icon":"cubes","pages":[{"title":"Widget overview","sidebarTitle":"Overview","icon":"paintbrush","href":"/widget/custom-components"},{"title":"React Components","icon":"react","href":"/widget/custom-components-react"},{"title":"Headless widget setup and hooks","sidebarTitle":"Headless","icon":"code","href":"/widget/custom-components-headless"}]},{"title":"Widget troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/widget/troubleshooting"}]},{"group":"AI X (Twitter) Support","pages":[{"title":"Connect X (Twitter)","icon":"plug","href":"/twitter/connect-twitter"}]},{"group":"AI App Review Support","pages":[{"title":"Connect App Store and Google Play reviews","sidebarTitle":"Connect app reviews","icon":"star","href":"/app-reviews/connect-app-reviews"}]},{"group":"AI WhatsApp Support","pages":[{"title":"Whatsapp overview","sidebarTitle":"Overview","icon":"comment-dots","href":"/whatsapp/introduction"},{"group":"Setup Channel","icon":"gear","pages":[{"title":"Create WhatsApp Agent","icon":"plug","href":"/whatsapp/connect-whatsapp"},{"title":"WhatsApp Flow","icon":"route","href":"/whatsapp/messaging-rules"},{"title":"Messaging Rules","icon":"scale-balanced","href":"/whatsapp/whatsapp-rules"}]},{"title":"Whatsapp troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/whatsapp/troubleshooting"}]},{"group":"AI SMS Support","pages":[{"title":"Sms overview","sidebarTitle":"Overview","icon":"comment-sms","href":"/sms/introduction"},{"group":"Setup Channel","icon":"gear","pages":[{"title":"Connect SMS","icon":"plug","href":"/sms/connect-sms"},{"title":"SMS Flow","icon":"route","href":"/sms/message-routing"},{"title":"US Number Compliance","icon":"flag","href":"/sms/compliance"}]},{"title":"Sms troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/sms/troubleshooting"}]},{"group":"Phone \u0026 Telephony","pages":[{"title":"Phone and telephony overview","sidebarTitle":"Overview","icon":"phone","href":"/phone/introduction"},{"group":"Setup","icon":"gear","pages":[{"title":"Phone numbers and routing","sidebarTitle":"Numbers and routing","icon":"phone","href":"/phone/numbers-and-routing"},{"title":"Create Phone Agent","icon":"plus","href":"/phone/create-agent"},{"title":"Agent Configuration","icon":"sliders","href":"/phone/agent-config"},{"title":"Classical IVR","href":"/phone/call-flows"},{"title":"SIP Integration","icon":"server","href":"/phone/sip-integration"}]},{"group":"Calling","icon":"phone","pages":[{"title":"Inbound Calls","icon":"phone-arrow-down-left","href":"/phone/inbound-calls"},{"title":"Call answering and ringing settings","sidebarTitle":"Call answering","icon":"phone-volume","href":"/phone/call-answering"},{"title":"Outbound Calls","icon":"phone-arrow-up-right","href":"/phone/outbound-calls"},{"title":"Human phone calling and transfers","sidebarTitle":"Human calling","icon":"phone","href":"/phone/human-calling"},{"title":"Live interpretation for team phone calls","sidebarTitle":"Live interpretation","icon":"language","href":"/phone/live-interpretation"},{"title":"Voice SDK integration","sidebarTitle":"App voice SDK","icon":"microphone","href":"/phone/voice-sdk"},{"title":"Phone Desk agent workspace","sidebarTitle":"Phone Desk","icon":"headset","href":"/phone/phone-desk"},{"title":"Phone recordings, transcripts, and summaries","sidebarTitle":"Recordings and transcripts","icon":"phone","href":"/phone/recordings-and-transcripts"}]},{"group":"Automation","icon":"bolt","pages":[{"title":"Phone call lifecycle and outcomes","sidebarTitle":"Call outcomes","icon":"phone","href":"/phone/call-outcomes"},{"title":"Phone follow-up workflows and callbacks","sidebarTitle":"Follow-up workflows","icon":"phone","href":"/phone/follow-up-workflows"}]},{"title":"Phone calling troubleshooting","sidebarTitle":"Troubleshooting","icon":"phone","href":"/phone/troubleshooting"}]},{"group":"AI Email Support","pages":[{"title":"Email overview","sidebarTitle":"Overview","icon":"envelope","href":"/email/introduction"},{"group":"Setup Channel","icon":"gear","pages":[{"title":"Sending Domains \u0026 DNS","icon":"globe","href":"/email/sending-domains"},{"title":"Sequence email sender settings","sidebarTitle":"Sequence senders","icon":"paper-plane","href":"/email/sequence-senders"},{"title":"Connect Email","icon":"paper-plane","href":"/email/forwarding"},{"title":"Email Flow","icon":"diagram-project","href":"/email/forwarding-rules"}]},{"title":"Email troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/email/troubleshooting"}]},{"group":"AI Actions","pages":[{"title":"AI Actions","sidebarTitle":"Overview","icon":"bolt","href":"/actions/introduction"},{"title":"Build An Action","sidebarTitle":"Build an action","icon":"plug","href":"/actions/build-an-action"},{"title":"OpenAPI Import","sidebarTitle":"OpenAPI import","icon":"file-import","href":"/actions/openapi-import"},{"title":"MCP Servers","sidebarTitle":"MCP servers","icon":"plug-circle-bolt","href":"/actions/mcp-servers"},{"title":"Authentication","sidebarTitle":"Authentication","icon":"shield-halved","href":"/actions/authentication"},{"title":"Execution","sidebarTitle":"Execution","icon":"diagram-project","href":"/actions/execution"},{"title":"Actions troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/actions/troubleshooting"}]},{"group":"Resources","pages":[{"title":"Manage Contacts","icon":"user","href":"/contacts/manage-contacts"},{"title":"Guaranteed Message Delivery","icon":"paper-plane","href":"/resources/guaranteed-delivery"},{"title":"Increase Automation","sidebarTitle":"Increase automation","icon":"chart-line","href":"/resources/increase-automation"},{"title":"Collect Customer Satisfaction","sidebarTitle":"CSAT","icon":"star","href":"/resources/csat"}]}]},{"tab":"Ticketing","icon":"ticket","groups":[{"group":"Ticketing","pages":[{"title":"Structured Fields","icon":"list-tree","href":"/ticketing/structured-fields"},{"title":"Inbox","href":"/inbox/intro"},{"title":"Session attribute dropdowns","sidebarTitle":"Attribute dropdowns","href":"/inbox/dropdown-attributes"}]}]},{"tab":"Connect","icon":"arrows-left-right","groups":[{"group":"Connect","pages":[{"title":"Connect overview","sidebarTitle":"Overview","icon":"arrows-left-right","href":"/connect/introduction"},{"title":"Connect quickstart","sidebarTitle":"Quickstart","icon":"rocket","href":"/connect/quickstart"}]},{"group":"Concepts","pages":[{"title":"Connect threads and lanes","sidebarTitle":"Threads \u0026 lanes","icon":"layer-group","href":"/connect/threads"},{"title":"Connect AI Supervisor","sidebarTitle":"AI Supervisor","icon":"shield-halved","href":"/connect/ai-supervisor"}]},{"group":"Reference","pages":[{"title":"Connect webhooks and events","sidebarTitle":"Webhooks","icon":"globe","href":"/connect/webhooks"}]}]},{"tab":"Integrations","icon":"plug","groups":[{"group":"Overview","pages":[{"title":"Integrations","icon":"plug","href":"/dashboard/introduction"}]},{"group":"Ticketing Systems","pages":[{"group":"Zendesk","icon":"headset","pages":[{"title":"Zendesk overview","sidebarTitle":"Overview","icon":"ticket","href":"/integrations/zendesk/overview"},{"group":"Setup Integration","icon":"gear","pages":[{"title":"Ticketing API","icon":"envelope","href":"/integrations/zendesk/ticketing-api"},{"title":"Sunshine Conversations","icon":"messages","href":"/integrations/zendesk/sunshine-conversations"}]},{"group":"Channels","icon":"grid-2","pages":[{"title":"AI Chat Widget","icon":"comments","href":"/integrations/zendesk/channels/widget"},{"title":"AI WhatsApp Support","icon":"whatsapp","href":"/integrations/zendesk/channels/whatsapp"},{"title":"AI SMS Support","icon":"comment-sms","href":"/integrations/zendesk/channels/sms"},{"title":"AI Phone Support","icon":"phone","href":"/integrations/zendesk/channels/phone"},{"title":"AI Email Support","icon":"envelope","href":"/integrations/zendesk/channels/email"}]},{"group":"Telephony","icon":"phone-arrow-down-left","pages":[{"title":"Zendesk Telephony","icon":"phone-arrow-up-right","href":"/integrations/zendesk/telephony"}]},{"title":"Zendesk troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/integrations/zendesk/troubleshooting"}]},{"group":"HubSpot","icon":"hubspot","pages":[{"title":"HubSpot overview","sidebarTitle":"Overview","icon":"bullseye","href":"/integrations/hubspot/overview"},{"group":"Setup Integration","icon":"gear","pages":[{"title":"Connect HubSpot","sidebarTitle":"Connect","icon":"plug","href":"/integrations/hubspot/connect"},{"title":"Migrate to OAuth","icon":"arrow-right-arrow-left","href":"/integrations/hubspot/oauth-migration"},{"title":"Handoff \u0026 Sync","icon":"arrow-right-arrow-left","href":"/integrations/hubspot/handoff"},{"title":"Webhook Reference","sidebarTitle":"Webhooks","icon":"webhook","href":"/integrations/hubspot/webhooks"}]},{"group":"Channels","icon":"grid-2","pages":[{"title":"AI Chat Widget","sidebarTitle":"Chat Widget","icon":"comments","href":"/integrations/hubspot/channels/widget"},{"title":"AI Email Support","sidebarTitle":"Email","icon":"envelope","href":"/integrations/hubspot/channels/email"},{"title":"AI WhatsApp Support","sidebarTitle":"WhatsApp","icon":"whatsapp","href":"/integrations/hubspot/channels/whatsapp"},{"title":"AI SMS Support","sidebarTitle":"SMS","icon":"comment-sms","href":"/integrations/hubspot/channels/sms"},{"title":"HubSpot phone support and call follow-ups","sidebarTitle":"Phone","icon":"phone","href":"/integrations/hubspot/channels/phone"}]},{"title":"HubSpot troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/integrations/hubspot/troubleshooting"}]},{"group":"Intercom","icon":"intercom","pages":[{"title":"Intercom overview","sidebarTitle":"Overview","icon":"messages","href":"/integrations/intercom/overview"},{"group":"Setup Integration","icon":"gear","pages":[{"title":"Connect Intercom","sidebarTitle":"Connect","icon":"plug","href":"/integrations/intercom/connect"},{"title":"Conversations","sidebarTitle":"Conversations","icon":"messages","href":"/integrations/intercom/conversations"}]},{"group":"Channels","icon":"grid-2","pages":[{"title":"Web (Messenger)","sidebarTitle":"Web","icon":"comments","href":"/integrations/intercom/channels/web"},{"title":"Email","sidebarTitle":"Email","icon":"envelope","href":"/integrations/intercom/channels/email"}]},{"title":"Intercom troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/integrations/intercom/troubleshooting"}]},{"group":"Front","icon":"inbox","pages":[{"title":"Front overview","sidebarTitle":"Overview","icon":"envelopes-bulk","href":"/integrations/front/overview"},{"group":"Setup Integration","icon":"gear","pages":[{"title":"Connect Front","sidebarTitle":"Connect","icon":"plug","href":"/integrations/front/connect"},{"title":"Conversations","sidebarTitle":"Conversations","icon":"messages","href":"/integrations/front/conversations"}]},{"group":"Channels","icon":"grid-2","pages":[{"title":"Email in Front","sidebarTitle":"Email","icon":"envelope","href":"/integrations/front/channels/email"},{"title":"Chat in Front","sidebarTitle":"Chat","icon":"comments","href":"/integrations/front/channels/web"},{"title":"SMS in Front","sidebarTitle":"SMS","icon":"comment-sms","href":"/integrations/front/channels/sms"},{"title":"Phone in Front","sidebarTitle":"Phone","icon":"phone","href":"/integrations/front/channels/phone"}]},{"title":"Front troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/integrations/front/troubleshooting"}]},{"group":"Gorgias","icon":"cart-shopping","pages":[{"title":"Gorgias overview","sidebarTitle":"Overview","icon":"life-ring","href":"/integrations/gorgias/overview"},{"group":"Setup Integration","icon":"gear","pages":[{"title":"Connect Gorgias","sidebarTitle":"Connect","icon":"plug","href":"/integrations/gorgias/connect"},{"title":"Ticket Flow","sidebarTitle":"Ticket Flow","icon":"diagram-project","href":"/integrations/gorgias/ticket-flow"}]},{"title":"Gorgias troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/integrations/gorgias/troubleshooting"}]},{"group":"Salesforce","icon":"cloud","pages":[{"title":"Salesforce overview","sidebarTitle":"Overview","icon":"handshake","href":"/integrations/salesforce/overview"},{"group":"Setup Integration","icon":"gear","pages":[{"title":"Email Cases","icon":"envelope","href":"/integrations/salesforce/email-cases"},{"title":"Live Messaging","icon":"messages","href":"/integrations/salesforce/live-messaging"}]},{"group":"Channels","icon":"grid-2","pages":[{"title":"AI Chat Widget in Salesforce","sidebarTitle":"Chat Widget","icon":"comments","href":"/integrations/salesforce/channels/widget"},{"title":"AI WhatsApp Support in Salesforce","sidebarTitle":"WhatsApp","icon":"whatsapp","href":"/integrations/salesforce/channels/whatsapp"},{"title":"AI SMS Support in Salesforce","sidebarTitle":"SMS","icon":"comment-sms","href":"/integrations/salesforce/channels/sms"},{"title":"AI Phone Support in Salesforce","sidebarTitle":"Phone","icon":"phone","href":"/integrations/salesforce/channels/phone"},{"title":"AI Email in Salesforce","sidebarTitle":"Email","icon":"envelope","href":"/integrations/salesforce/channels/email"}]},{"title":"Salesforce troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/integrations/salesforce/troubleshooting"}]},{"group":"Dynamics 365","icon":"building","pages":[{"title":"Dynamics 365 overview","sidebarTitle":"Overview","icon":"briefcase","href":"/integrations/dynamics-365/overview"},{"group":"Setup Integration","icon":"gear","pages":[{"title":"Azure \u0026 Dynamics Setup","sidebarTitle":"Azure \u0026 Dynamics Setup","icon":"microsoft","href":"/integrations/dynamics-365/azure-setup"},{"title":"Connect to OpenCX","sidebarTitle":"Connect","icon":"plug","href":"/integrations/dynamics-365/connect"},{"title":"Conversations in Dynamics 365","sidebarTitle":"Conversations","icon":"diagram-project","href":"/integrations/dynamics-365/conversations"}]},{"group":"Channels","icon":"grid-2","pages":[{"title":"AI Chat Widget in Dynamics 365","sidebarTitle":"AI Chat Widget","icon":"comments","href":"/integrations/dynamics-365/channels/widget"},{"title":"AI WhatsApp Support in Dynamics 365","sidebarTitle":"AI WhatsApp Support","icon":"whatsapp","href":"/integrations/dynamics-365/channels/whatsapp"},{"title":"AI SMS Support in Dynamics 365","sidebarTitle":"AI SMS Support","icon":"comment-sms","href":"/integrations/dynamics-365/channels/sms"},{"title":"AI Phone Support in Dynamics 365","sidebarTitle":"AI Phone Support","icon":"phone","href":"/integrations/dynamics-365/channels/phone"},{"title":"AI Email Support in Dynamics 365","sidebarTitle":"AI Email Support","icon":"envelope","href":"/integrations/dynamics-365/channels/email"}]},{"title":"Dynamics 365 troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/integrations/dynamics-365/troubleshooting"}]},{"group":"Twilio Flex","icon":"phone","pages":[{"title":"Twilio Flex overview","sidebarTitle":"Overview","icon":"headset","href":"/integrations/twilio-flex/overview"},{"group":"Setup Integration","icon":"gear","pages":[{"title":"Connect Twilio Flex","sidebarTitle":"Connect","icon":"plug","href":"/integrations/twilio-flex/connect"},{"title":"Handoff and task attributes","sidebarTitle":"Handoff","icon":"user-group","href":"/integrations/twilio-flex/handoff"}]},{"group":"Channels","icon":"grid-2","pages":[{"title":"Web Chat in Twilio Flex","sidebarTitle":"Web Chat","icon":"comments","href":"/integrations/twilio-flex/channels/web-chat"},{"title":"Voice in Twilio Flex","sidebarTitle":"Voice","icon":"phone","href":"/integrations/twilio-flex/channels/voice"},{"title":"SMS in Twilio Flex","sidebarTitle":"SMS","icon":"comment-sms","href":"/integrations/twilio-flex/channels/sms"},{"title":"WhatsApp in Twilio Flex","sidebarTitle":"WhatsApp","icon":"whatsapp","href":"/integrations/twilio-flex/channels/whatsapp"}]},{"title":"Twilio Flex troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/integrations/twilio-flex/troubleshooting"}]},{"group":"Freshchat","icon":"comment","pages":[{"title":"Freshchat overview","sidebarTitle":"Overview","icon":"messages","href":"/integrations/freshchat/overview"},{"group":"Setup Integration","icon":"gear","pages":[{"title":"Connect Freshchat","sidebarTitle":"Connect","icon":"plug","href":"/integrations/freshchat/connect"},{"title":"Conversation flow","sidebarTitle":"Conversation flow","icon":"diagram-project","href":"/integrations/freshchat/conversations"}]},{"title":"Freshchat troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/integrations/freshchat/troubleshooting"}]},{"group":"Freshdesk","icon":"ticket","pages":[{"title":"Freshdesk ticketing overview","sidebarTitle":"Overview","icon":"ticket","href":"/integrations/freshdesk/overview"},{"group":"Setup Integration","icon":"gear","pages":[{"title":"Connect Freshdesk ticketing","sidebarTitle":"Connect","icon":"plug","href":"/integrations/freshdesk/connect"},{"title":"Freshdesk ticket flow","sidebarTitle":"Ticket flow","icon":"diagram-project","href":"/integrations/freshdesk/tickets"}]},{"title":"Freshdesk ticketing troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/integrations/freshdesk/troubleshooting"}]},{"group":"Infobip","icon":"comments","pages":[{"title":"Infobip overview","sidebarTitle":"Overview","icon":"comments","href":"/integrations/infobip/overview"},{"title":"Connect Infobip","sidebarTitle":"Connect","icon":"plug","href":"/integrations/infobip/connect"},{"title":"Infobip troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/integrations/infobip/troubleshooting"}]},{"group":"Jira","icon":"list-check","pages":[{"title":"Jira overview","sidebarTitle":"Overview","icon":"bug","href":"/integrations/jira/overview"},{"group":"Setup Integration","icon":"gear","pages":[{"title":"Connect Jira","icon":"plug","href":"/integrations/jira/connect"},{"title":"Issue Flow","icon":"diagram-project","href":"/integrations/jira/issue-flow"}]},{"title":"Jira troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/integrations/jira/troubleshooting"}]},{"group":"Creatio","icon":"grid-2","pages":[{"title":"Creatio overview","sidebarTitle":"Overview","icon":"shapes","href":"/integrations/creatio/overview"},{"group":"Setup Integration","icon":"gear","pages":[{"title":"Connect Creatio","sidebarTitle":"Connect","icon":"plug","href":"/integrations/creatio/connect"},{"title":"Case Sync","sidebarTitle":"Case Sync","icon":"arrows-rotate","href":"/integrations/creatio/case-sync"},{"title":"AI Fields","sidebarTitle":"AI Fields","icon":"wand-magic-sparkles","href":"/integrations/creatio/ai-fields"}]},{"group":"Channels","icon":"grid-2","pages":[{"title":"AI Chat Widget in Creatio","sidebarTitle":"Widget","icon":"comments","href":"/integrations/creatio/channels/widget"},{"title":"AI WhatsApp Support in Creatio","sidebarTitle":"WhatsApp","icon":"whatsapp","href":"/integrations/creatio/channels/whatsapp"},{"title":"AI SMS Support in Creatio","sidebarTitle":"SMS","icon":"comment-sms","href":"/integrations/creatio/channels/sms"},{"title":"AI Phone Support in Creatio","sidebarTitle":"Phone","icon":"phone","href":"/integrations/creatio/channels/phone"},{"title":"AI Email Support in Creatio","sidebarTitle":"Email","icon":"envelope","href":"/integrations/creatio/channels/email"}]},{"title":"Creatio troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/integrations/creatio/troubleshooting"}]},{"group":"Pipedrive","icon":"users-viewfinder","pages":[{"title":"Pipedrive overview","sidebarTitle":"Overview","icon":"chart-line","href":"/integrations/pipedrive/overview"},{"title":"Pipedrive connect","sidebarTitle":"Connect","icon":"plug","href":"/integrations/pipedrive/connect"},{"title":"Update Lead Action","icon":"user-round-pen","href":"/integrations/pipedrive/update-lead-action"},{"title":"Trigger workflows from Pipedrive","icon":"bolt","href":"/integrations/pipedrive/webhook-trigger"},{"title":"Pipedrive troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/integrations/pipedrive/troubleshooting"}]},{"group":"Aircall","icon":"phone","pages":[{"title":"Aircall overview","sidebarTitle":"Overview","icon":"phone","href":"/integrations/aircall/overview"},{"title":"Aircall connect","sidebarTitle":"Connect","icon":"plug","href":"/integrations/aircall/connect"},{"title":"Post Call Context Action","icon":"phone-forwarded","href":"/integrations/aircall/post-call-context-action"},{"title":"Aircall troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/integrations/aircall/troubleshooting"}]}]},{"group":"E-commerce","pages":[{"group":"Shopify","icon":"shopify","pages":[{"title":"Shopify overview","sidebarTitle":"Overview","icon":"store","href":"/integrations/shopify/overview"},{"group":"Setup Integration","icon":"gear","pages":[{"title":"Connect Shopify","sidebarTitle":"Connect Store","icon":"plug","href":"/integrations/shopify/connect"},{"title":"AI Actions","sidebarTitle":"AI Actions","icon":"robot","href":"/integrations/shopify/ai-actions"}]},{"title":"Contact Metadata","sidebarTitle":"Contact Metadata","icon":"address-card","href":"/integrations/shopify/contact-metadata"},{"title":"Shopify troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/integrations/shopify/troubleshooting"}]},{"group":"FareHarbor","icon":"anchor","pages":[{"title":"Fareharbor overview","sidebarTitle":"Overview","icon":"calendar-check","href":"/integrations/fareharbor/overview"},{"group":"Setup Integration","icon":"gear","pages":[{"title":"Connect FareHarbor","icon":"plug","href":"/integrations/fareharbor/connect"},{"title":"Booking Flow","icon":"route","href":"/integrations/fareharbor/booking-flow"}]},{"group":"Channels","icon":"grid-2","pages":[{"title":"Chat in FareHarbor","sidebarTitle":"Chat","icon":"comments","href":"/integrations/fareharbor/channels/chat"},{"title":"Voice in FareHarbor","sidebarTitle":"Voice","icon":"phone","href":"/integrations/fareharbor/channels/voice"}]},{"title":"Fareharbor troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/integrations/fareharbor/troubleshooting"}]}]},{"group":"Other Integrations","pages":[{"title":"Zapier","icon":"asterisk","href":"/dashboard/zapier"}]}]},{"tab":"MCP","icon":"network-wired","groups":[{"group":"Overview","pages":[{"title":"MCP overview","sidebarTitle":"Overview","icon":"plug","href":"/mcp/introduction"},{"title":"Mcp get started","sidebarTitle":"Get Started","icon":"download","href":"/mcp/install"}]},{"group":"Client Guides","pages":[{"title":"Cursor","icon":"https://mintlify.s3.us-west-1.amazonaws.com/openchat/images/mcp/cursor.svg","href":"/mcp/clients/cursor"},{"group":"Claude","icon":"/images/mcp/claude.svg","pages":[{"title":"Claude Desktop","sidebarTitle":"Desktop","icon":"https://mintlify.s3.us-west-1.amazonaws.com/openchat/images/mcp/claude.svg","href":"/mcp/clients/claude-desktop"},{"title":"Claude Code","sidebarTitle":"Code","icon":"https://mintlify.s3.us-west-1.amazonaws.com/openchat/images/mcp/claude.svg","href":"/mcp/clients/claude-code"}]},{"title":"Visual Studio Code","sidebarTitle":"VS Code","icon":"https://mintlify.s3.us-west-1.amazonaws.com/openchat/images/mcp/vscode.svg","href":"/mcp/clients/vscode"},{"title":"Windsurf","icon":"https://mintlify.s3.us-west-1.amazonaws.com/openchat/images/mcp/windsurf.svg","href":"/mcp/clients/windsurf"},{"title":"Zed","icon":"https://mintlify.s3.us-west-1.amazonaws.com/openchat/images/mcp/zed.svg","href":"/mcp/clients/zed"}]},{"group":"Reference","pages":[{"title":"Prompt Library","sidebarTitle":"Prompts","icon":"message","href":"/mcp/prompts"},{"title":"Tools Reference","sidebarTitle":"Tools","icon":"toolbox","href":"/mcp/tools"},{"title":"Workflows","sidebarTitle":"Workflows","icon":"lightbulb","href":"/mcp/use-cases"},{"title":"Mcp troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/mcp/troubleshooting"}]}]},{"tab":"Agent Training","icon":"book","groups":[{"group":"Agent Knowledge","pages":[{"title":"Agent Knowledge","sidebarTitle":"Overview","icon":"book","href":"/knowledge/introduction"},{"title":"Connect a knowledge source","sidebarTitle":"Knowledge Sources","icon":"brain","href":"/knowledge/sources/overview"},{"group":"AI Instructions","icon":"sliders","pages":[{"title":"AI Instructions","sidebarTitle":"Overview","icon":"sliders","href":"/ai-instructions/overview"},{"title":"Training scenarios","sidebarTitle":"Training scenarios","icon":"rabbit","href":"/ai-instructions/training-scenarios"}]},{"group":"Help Center","icon":"book-open","pages":[{"title":"Help Center","sidebarTitle":"Overview","icon":"book-open","href":"/help-center/overview"},{"title":"Articles","sidebarTitle":"Articles","icon":"file-lines","href":"/help-center/articles"},{"title":"Categories","sidebarTitle":"Categories","icon":"folder-tree","href":"/help-center/categories"},{"title":"Translations","sidebarTitle":"Translations","icon":"language","href":"/help-center/translations"}]}]},{"group":"Main Knowledge Sources","icon":"database","pages":[{"group":"Website","icon":"globe","pages":[{"title":"Website","sidebarTitle":"Overview","icon":"sitemap","href":"/knowledge/sources/website/overview"},{"title":"Connect a website","sidebarTitle":"Connect","icon":"plug","href":"/knowledge/sources/website/connect"},{"title":"Website troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/knowledge/sources/website/troubleshooting"}]},{"group":"Zendesk","icon":"headset","pages":[{"title":"Zendesk","sidebarTitle":"Overview","icon":"book","href":"/knowledge/sources/zendesk/overview"},{"title":"Connect Zendesk","sidebarTitle":"Connect","icon":"plug","href":"/knowledge/sources/zendesk/connect"},{"title":"Zendesk troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/knowledge/sources/zendesk/troubleshooting"}]},{"group":"Intercom","icon":"intercom","pages":[{"title":"Intercom","sidebarTitle":"Overview","icon":"circle-question","href":"/knowledge/sources/intercom/overview"},{"title":"Connect Intercom","sidebarTitle":"Connect","icon":"plug","href":"/knowledge/sources/intercom/connect"},{"title":"Intercom troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/knowledge/sources/intercom/troubleshooting"}]},{"group":"Front","icon":"inbox","pages":[{"title":"Front","sidebarTitle":"Overview","icon":"envelopes-bulk","href":"/knowledge/sources/front/overview"},{"title":"Connect Front","sidebarTitle":"Connect","icon":"plug","href":"/knowledge/sources/front/connect"},{"title":"Front troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/knowledge/sources/front/troubleshooting"}]},{"group":"Confluence","icon":"confluence","pages":[{"title":"Confluence","sidebarTitle":"Overview","icon":"file-lines","href":"/knowledge/sources/confluence/overview"},{"title":"Connect Confluence","sidebarTitle":"Connect","icon":"plug","href":"/knowledge/sources/confluence/connect"},{"title":"Confluence troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/knowledge/sources/confluence/troubleshooting"}]},{"group":"Notion","icon":"n","pages":[{"title":"Notion","sidebarTitle":"Overview","icon":"note-sticky","href":"/knowledge/sources/notion/overview"},{"title":"Connect Notion","sidebarTitle":"Connect","icon":"plug","href":"/knowledge/sources/notion/connect"},{"title":"Notion troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/knowledge/sources/notion/troubleshooting"}]},{"group":"Shopify","icon":"shopify","pages":[{"title":"Shopify","sidebarTitle":"Overview","icon":"bag-shopping","href":"/knowledge/sources/shopify/overview"},{"title":"Connect Shopify","sidebarTitle":"Connect","icon":"plug","href":"/knowledge/sources/shopify/connect"},{"title":"Shopify troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/knowledge/sources/shopify/troubleshooting"}]},{"group":"GitBook","icon":"book","pages":[{"title":"GitBook","sidebarTitle":"Overview","icon":"book-open","href":"/knowledge/sources/gitbook/overview"},{"title":"Connect GitBook","sidebarTitle":"Connect","icon":"plug","href":"/knowledge/sources/gitbook/connect"},{"title":"Gitbook troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/knowledge/sources/gitbook/troubleshooting"}]},{"group":"Freshdesk","icon":"headset","pages":[{"title":"Freshdesk","sidebarTitle":"Overview","icon":"book","href":"/knowledge/sources/freshdesk/overview"},{"title":"Connect Freshdesk","sidebarTitle":"Connect","icon":"plug","href":"/knowledge/sources/freshdesk/connect"},{"title":"Freshdesk troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/knowledge/sources/freshdesk/troubleshooting"}]},{"group":"HubSpot Knowledge Base","icon":"hubspot","pages":[{"title":"HubSpot Knowledge Base","sidebarTitle":"Overview","icon":"hubspot","href":"/knowledge/sources/hubspot-kb/overview"},{"title":"Connect HubSpot Knowledge Base","sidebarTitle":"Connect","icon":"plug","href":"/knowledge/sources/hubspot-kb/connect"},{"title":"HubSpot Knowledge Base troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/knowledge/sources/hubspot-kb/troubleshooting"}]}]},{"group":"Additional Knowledge Sources","icon":"layer-group","pages":[{"group":"Google Docs","icon":"file-lines","pages":[{"title":"Google Docs","sidebarTitle":"Overview","icon":"file-word","href":"/knowledge/additional-sources/google-docs/overview"}]},{"group":"Google Sheets","icon":"table","pages":[{"title":"Google Sheets","sidebarTitle":"Overview","icon":"table-cells","href":"/knowledge/additional-sources/google-sheets/overview"}]},{"group":"GitHub","icon":"code-branch","pages":[{"title":"GitHub","sidebarTitle":"Overview","icon":"code-pull-request","href":"/knowledge/additional-sources/github/overview"}]},{"group":"Slack","icon":"comments","pages":[{"title":"Slack","sidebarTitle":"Overview","icon":"hashtag","href":"/knowledge/additional-sources/slack/overview"}]},{"group":"Airtable","icon":"table","pages":[{"title":"Airtable","sidebarTitle":"Overview","icon":"database","href":"/knowledge/additional-sources/airtable/overview"}]},{"group":"Coda","icon":"file-code","pages":[{"title":"Coda","sidebarTitle":"Overview","icon":"note-sticky","href":"/knowledge/additional-sources/coda/overview"}]},{"group":"OneDrive","icon":"cloud","pages":[{"title":"OneDrive","sidebarTitle":"Overview","icon":"folder-open","href":"/knowledge/additional-sources/onedrive/overview"}]},{"group":"SharePoint","icon":"building","pages":[{"title":"SharePoint","sidebarTitle":"Overview","icon":"folder-tree","href":"/knowledge/additional-sources/sharepoint/overview"}]},{"group":"Asana","icon":"list-check","pages":[{"title":"Asana","sidebarTitle":"Overview","icon":"clipboard-check","href":"/knowledge/additional-sources/asana/overview"}]},{"group":"Monday.com","icon":"calendar-days","pages":[{"title":"Monday.com","sidebarTitle":"Overview","icon":"kanban","href":"/knowledge/additional-sources/monday-com/overview"}]},{"group":"MongoDB","icon":"database","pages":[{"title":"MongoDB","sidebarTitle":"Overview","icon":"leaf","href":"/knowledge/additional-sources/mongodb/overview"}]},{"group":"Snowflake","icon":"chart-network","pages":[{"title":"Snowflake","sidebarTitle":"Overview","icon":"snowflake","href":"/knowledge/additional-sources/snowflake/overview"}]},{"group":"BigQuery","icon":"chart-column","pages":[{"title":"BigQuery","sidebarTitle":"Overview","icon":"warehouse","href":"/knowledge/additional-sources/bigquery/overview"}]},{"group":"CSV/Excel","icon":"file-csv","pages":[{"title":"CSV / Excel","sidebarTitle":"Overview","icon":"table-list","href":"/knowledge/additional-sources/csv-excel/overview"}]},{"group":"REST API","icon":"code","pages":[{"title":"REST API","sidebarTitle":"Overview","icon":"terminal","href":"/knowledge/additional-sources/rest-api/overview"}]}]}]},{"tab":"AI Safety","icon":"shield","pages":[{"title":"AI Safety \u0026 Control","icon":"shield-check","href":"/safety/introduction"},{"title":"Real-Time AI Monitoring","icon":"eye","href":"/safety/inspect-mode"},{"title":"Understanding AI Decisions","icon":"magnifying-glass","href":"/safety/debug-mode"},{"title":"PII Redaction","icon":"user-shield","href":"/safety/pii-redaction"},{"title":"AI Context Rules","icon":"database","href":"/safety/ai-context"},{"title":"Human Handoff","icon":"user-headset","href":"/handoff/introduction"},{"title":"Handoff Settings","icon":"sliders","href":"/handoff/settings"},{"title":"Handoff Topics","sidebarTitle":"Handoff topics","icon":"shield-halved","href":"/handoff/topics"},{"title":"Data retention policy","sidebarTitle":"Data retention","icon":"calendar-clock","href":"/security/data-retention"},{"title":"Single sign-on (SSO)","sidebarTitle":"Single sign-on (SSO)","icon":"key","href":"/security/sso/overview"},{"title":"Audit logs overview","sidebarTitle":"Audit logs","icon":"clipboard-list","href":"/security/audit-logs"},{"title":"Security Policy","icon":"shield-check","href":"/security/bug-bounty"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Overview","pages":[{"title":"Authentication","icon":"key","href":"/api-reference/authentication"}]},{"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":"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"}]},{"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":"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","description":"List the variables a macro body can use: built-in system variables and your custom variables. Read-only; custom variables are authored in the dashboard.","title":"List macro variables","href":"/api-reference/macros/variables"},{"openapi":"get /macros/settings","sidebarTitle":"Get settings","title":null,"href":"/api-reference/macros/get-settings"},{"openapi":"put /macros/settings","sidebarTitle":"Update settings","description":"Choose the languages every org-wide macro is translated into. The list replaces the current one; send an empty list to turn macro translation off.","title":null,"href":"/api-reference/macros/update-settings"},{"openapi":"get /macros/{id}/translations","sidebarTitle":"Get translations","title":null,"href":"/api-reference/macros/translations"},{"openapi":"post /macros/{id}/translations/retranslate","sidebarTitle":"Retranslate","title":null,"href":"/api-reference/macros/retranslate"},{"openapi":"get /macros/suggestion-insights","sidebarTitle":"List suggestion insights","title":null,"href":"/api-reference/macros/suggestion-insights-list"},{"openapi":"get /macros/{id}/suggestion-insights","sidebarTitle":"Get suggestion insights","title":null,"href":"/api-reference/macros/suggestion-insights-get"}]},{"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"},{"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":"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"},{"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"}]}]},{"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"}]},{"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":"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":"Assign","openapi":"post /chat/sessions/{session_id}/assignee","title":"Assign or unassign a chat session","href":"/api-reference/chat-sessions/assignee"},{"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","title":"Delete a session comment","href":"/api-reference/chat-sessions/delete_comment"},{"openapi":"post /chat/sessions/{session_id}/handoff","sidebarTitle":"Handoff","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"}]},{"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":"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":"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"}]},{"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"}]},{"group":"AI WhatsApp","pages":[{"openapi":"post /whatsapp/send-template","sidebarTitle":"Send template","title":"Send a WhatsApp template","href":"/api-reference/whatsapp/send-template"}]},{"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"}]},{"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/{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"}]},{"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"}]}]},{"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":"Media","pages":[{"title":"Media","icon":"image","href":"/api-reference/media/index"},{"openapi":"post /media/upload","sidebarTitle":"Upload an image","title":"Upload an image","href":"/api-reference/media/upload"}]},{"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":"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":"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":"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":"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"}]}]},{"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"}]},{"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":"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":"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"}]},{"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":"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":"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":"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"}]},{"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"}]},{"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":"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":"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}/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"}]},{"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":"Webhooks","pages":[{"title":"Event Types","icon":"globe","href":"/api-reference/webhooks/types"}]}]},{"tab":"Partners","icon":"handshake","groups":[{"group":"Partner Program","pages":[{"title":"Partner Platform","icon":"handshake","href":"/partners/introduction"},{"title":"Quickstart","icon":"rocket","href":"/partners/quickstart"},{"title":"Integration Guide","icon":"map","href":"/partners/integration-guide"},{"title":"Partner Admin Console","icon":"gauge","href":"/partners/admin-console"},{"title":"Partner Analytics","icon":"chart-mixed","href":"/partners/analytics"},{"title":"API Reference","icon":"code","href":"/partners/api-reference"},{"title":"Branding","icon":"paintbrush","href":"/partners/branding"}]}]}]},"title":"Get settings - Open.cx Docs","buildId":"dpl_37ZDLJcyt8yhrTVF6LiYvX7LvmXB","deploymentId":"dpl_37ZDLJcyt8yhrTVF6LiYvX7LvmXB","dynamics":["b0f84f53ff"],"chunks":["Page-BJyN-Pyl.js","ApiExamples-DmFxD0xq.js","utils-DczNJjF5.js","_Uint8Array-JMZMJLdF.js","isArray-CXeVWmfx.js","isObject-Bw72BMo0.js","cloneDeep-CsK1MRZH.js","utils-HBB8lD2H.js","toString-Ci69GPsS.js","snippetPresets-DE9Veup3.js","style-to-object-8s5bpEGF.js","v4-DIgz8zy6.js","isEqual-XZWsFdP7.js","usePlaygroundInputsStore-DUA9Zwq8.js","shallow-B6Ze1dM7.js","getApiPlaygroundDisplay-BT3DBUkY.js","ChevronDownIcon-D7Zj4Qv8.js","CodeSnippet-DrM1rj8h.js","CodeSnippets-aJiGQnbU.js","getPastedJson-BDAgG4pn.js","icon-Cjjyhdhp.js","MethodPill-BeuQBMOx.js","DynamicMarkdown-CfHSxJMP.js","addUniqueKeysToSchema-C4KT4ObS.js","SectionHeading-DQBnUljP.js","PlusIcon-DJ4_zRc8.js","TrashIcon-_SwExC9Q.js","axios-CXgqDoFS.js"]}