Requires appointments:read. Results are restricted to the API key’s account and an RFC3339 range of at most 366 days. Use the dedicated catalog, resources, services and availability endpoints for focused integration reads.
Your personal access token where supported, or a scoped API key (hc_…) created inside HueChat at Account → Developer API. Send it as Authorization: Bearer <token>.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"HueChat","description":"The HueChat API: conversations, messages, contacts, Customer CDP, Sales CRM, appointments, forms, inboxes, AI agents, templates, broadcasts and workflows, scoped to your own account.","colors":{"primary":"#6C5CE7","light":"#9B8FF2","dark":"#4E3FC7"},"logo":{"light":"https://mintcdn.com/huechat-ai/x4DYXX8dNO7UqvMj/logo/light.png?fit=max\u0026auto=format\u0026n=x4DYXX8dNO7UqvMj\u0026q=85\u0026s=aeae34b3f7d708b952ad3c7eade2b0b0","dark":"https://mintcdn.com/huechat-ai/x4DYXX8dNO7UqvMj/logo/dark.png?fit=max\u0026auto=format\u0026n=x4DYXX8dNO7UqvMj\u0026q=85\u0026s=263af7fc16473c725c656e66a0a84cf0","href":"https://huechat.ai"},"favicon":"https://mintcdn.com/huechat-ai/x4DYXX8dNO7UqvMj/favicon.png?fit=max\u0026auto=format\u0026n=x4DYXX8dNO7UqvMj\u0026q=85\u0026s=e6ea90816fff89c5e6847287199ec6af","api":{"playground":{"display":"interactive"}},"navbar":{"links":[{"href":"https://app.huechat.ai/app/login","label":"Sign in"}],"primary":{"type":"button","label":"Start free","href":"https://huechat.ai/signup"}},"footer":{"links":[{"header":"HueChat","items":[{"label":"Home","href":"https://huechat.ai"},{"label":"Pricing","href":"https://huechat.ai/pricing"},{"label":"Sign in","href":"https://app.huechat.ai/app/login"},{"label":"System status","href":"https://status.huechat.ai"}]},{"header":"Legal","items":[{"label":"Terms","href":"https://huechat.ai/terms"},{"label":"Privacy","href":"https://huechat.ai/privacy"},{"label":"Cookies","href":"https://huechat.ai/cookies"}]}]},"seo":{"metatags":{"canonical":"https://developers.huechat.ai"}},"contextual":{"options":["copy","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":"introduction"},{"language":"ar","href":"ar/introduction"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"huechat-ai","hasAudioNarration":false,"actualSubdomain":"huechat-ai","customDomains":["developers.huechat.ai"],"gitSource":{"type":"github","owner":"alsaif","repo":"huechat-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ad638fa4613fdc88741eb71","collectionId":"8b576961-75b2-4a7f-b3ab-69dbf7e8308c","liveDeploymentHistoryId":"6ad638fa4613fdc88741eb71","schemaVersion":"v3"},"entitlements":{},"buildId":"6ad638fa4613fdc88741eb71","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API reference","count":338},{"language":"default","tag":"Endpoints","count":338},{"language":"default","tag":"Sales CRM","count":90},{"language":"default","tag":"Customer CDP","count":46},{"language":"default","tag":"Appointments","count":41},{"language":"default","tag":"Forms","count":32},{"language":"default","tag":"Conversations","count":24},{"language":"default","tag":"AI Agents","count":20},{"language":"default","tag":"Knowledge","count":18},{"language":"en","tag":"Guide","count":15},{"language":"ar","tag":"الدليل","count":15},{"language":"default","tag":"Workflows","count":13},{"language":"en","tag":"Integrate","count":7},{"language":"ar","tag":"التكامل","count":7},{"language":"en","tag":"Get started","count":4},{"language":"en","tag":"Working with the API","count":4},{"language":"ar","tag":"ابدأ هنا","count":4},{"language":"ar","tag":"العمل مع الواجهة","count":4},{"language":"en","tag":"API reference","count":1},{"language":"en","tag":"Overview","count":1},{"language":"ar","tag":"مرجع API","count":1},{"language":"ar","tag":"نظرة عامة","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"workos-onboarding","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":"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":"editor-version-history-v2","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":"billing-page-v2","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":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","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":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"brand.css","content":"img.nav-logo{height:40px!important;max-height:40px;max-width:220px!important;width:auto}"},{"filePath":"rtl.css","content":"html[lang=ar]{direction:rtl}html[lang=ar] code,html[lang=ar] kbd,html[lang=ar] pre,html[lang=ar] samp{direction:ltr;unicode-bidi:isolate;text-align:left}html[lang=ar] [role=dialog] input,html[lang=ar] [role=dialog] textarea{direction:ltr;text-align:left}@media (min-width:1024px){html[lang=ar] #sidebar{left:auto;right:0;border-right:0;border-left:1px solid rgb(229 231 235/.7)}html[lang=ar].dark #sidebar{border-left-color:rgb(255 255 255/.07)}html[lang=ar] #content-container{margin-left:0!important;margin-right:var(--sidebar-width, 19rem)!important}}"}],"page":{"pagePath":"api-reference/appointments/list-appointments-and-catalog","slug":"/api-reference/appointments/list-appointments-and-catalog","pageMetadata":{"title":"List appointments and catalog","description":"Requires appointments:read. Results are restricted to the API key's account and an RFC3339 range of at most 366 days. Use the dedicated catalog, resources, services and availability endpoints for focused integration reads.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments","href":"/api-reference/appointments/list-appointments-and-catalog","autogeneratedByOpenApi":true},"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: \"Requires appointments:read. Results are restricted to the API key’s account and an RFC3339 range of at most 366 days. Use the dedicated catalog, resources, services and availability endpoints for focused integration reads.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}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":{"config":{},"pageMetadata":{"title":"List appointments and catalog","description":"Requires appointments:read. Results are restricted to the API key's account and an RFC3339 range of at most 366 days. Use the dedicated catalog, resources, services and availability endpoints for focused integration reads.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments","href":"/api-reference/appointments/list-appointments-and-catalog","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"security":["f0ca67ab-bf38-40f0-8714-2b58cc459876"],"description":"Requires appointments:read. Results are restricted to the API key's account and an RFC3339 range of at most 366 days. Use the dedicated catalog, resources, services and availability endpoints for focused integration reads.","tags":["Appointments"],"summary":"List appointments and catalog","parameters":["0559deea-b0f2-41b9-aad0-c6299212877c","a7a057c1-a10d-4d3b-83bc-2d7a135676f2","c50361ae-f751-409e-8443-0f4ba1ae8758"],"responses":{"200":"dba9de79-74a4-4066-b595-4e7445874eed","400":"3031906d-e09a-4acf-a74c-19e12d2a5767","401":"dddd326f-d8c0-4264-874d-afcb2a67aa14","403":"8bfc1742-4f5e-4f99-8139-1456326bba3c","429":"5d63e487-5b86-4b99-b10e-31034834d32c","503":"8c50086c-99b2-467a-ab74-af466d0972b0"},"method":"get","type":"path","servers":["4b252eaf-e4f5-4562-8dc6-7e1f203e966d"],"path":"/api/v2/accounts/{accountId}/appointments","baseUrlOptions":["https://app.huechat.ai"],"title":"List appointments and catalog","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"0559deea-b0f2-41b9-aad0-c6299212877c":{"description":"HueChat account ID","name":"accountId","in":"path","required":true,"schema":{"type":"integer","isRequired":true,"description":"HueChat account ID","uniqueKey":"","typeLabel":"integer"}},"a7a057c1-a10d-4d3b-83bc-2d7a135676f2":{"description":"Range start (RFC3339)","name":"start","in":"query","schema":{"type":"string","description":"Range start (RFC3339)","uniqueKey":"","typeLabel":"string"}},"c50361ae-f751-409e-8443-0f4ba1ae8758":{"description":"Range end (RFC3339)","name":"end","in":"query","schema":{"type":"string","description":"Range end (RFC3339)","uniqueKey":"","typeLabel":"string"}}},"responses":{"dba9de79-74a4-4066-b595-4e7445874eed":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"appointments":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"integer","uniqueKey":"appointments.items.[INDEX].account_id","typeLabel":"integer"},"buffer_after_minutes":{"type":"integer","uniqueKey":"appointments.items.[INDEX].buffer_after_minutes","typeLabel":"integer"},"buffer_before_minutes":{"type":"integer","uniqueKey":"appointments.items.[INDEX].buffer_before_minutes","typeLabel":"integer"},"busy_ends_at":{"type":"string","format":"date-time","uniqueKey":"appointments.items.[INDEX].busy_ends_at","typeLabel":"string\u003cdate-time>"},"busy_starts_at":{"type":"string","format":"date-time","uniqueKey":"appointments.items.[INDEX].busy_starts_at","typeLabel":"string\u003cdate-time>"},"cancellation_reason":{"type":"string","uniqueKey":"appointments.items.[INDEX].cancellation_reason","typeLabel":"string"},"cancelled_at":{"type":"string","format":"date-time","uniqueKey":"appointments.items.[INDEX].cancelled_at","typeLabel":"string\u003cdate-time>"},"completed_at":{"type":"string","format":"date-time","uniqueKey":"appointments.items.[INDEX].completed_at","typeLabel":"string\u003cdate-time>"},"confirmed_at":{"type":"string","format":"date-time","uniqueKey":"appointments.items.[INDEX].confirmed_at","typeLabel":"string\u003cdate-time>"},"contact_id":{"type":"integer","uniqueKey":"appointments.items.[INDEX].contact_id","typeLabel":"integer"},"conversation_id":{"type":"integer","uniqueKey":"appointments.items.[INDEX].conversation_id","typeLabel":"integer"},"created_at":{"type":"string","format":"date-time","uniqueKey":"appointments.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"created_by_ai_agent_id":{"type":"string","format":"uuid","uniqueKey":"appointments.items.[INDEX].created_by_ai_agent_id","typeLabel":"string\u003cuuid>"},"created_by_user_id":{"type":"integer","uniqueKey":"appointments.items.[INDEX].created_by_user_id","typeLabel":"integer"},"customer_email":{"type":"string","uniqueKey":"appointments.items.[INDEX].customer_email","typeLabel":"string"},"customer_name":{"type":"string","uniqueKey":"appointments.items.[INDEX].customer_name","typeLabel":"string"},"customer_phone":{"type":"string","uniqueKey":"appointments.items.[INDEX].customer_phone","typeLabel":"string"},"duration_minutes":{"type":"integer","uniqueKey":"appointments.items.[INDEX].duration_minutes","typeLabel":"integer"},"ends_at":{"type":"string","format":"date-time","uniqueKey":"appointments.items.[INDEX].ends_at","typeLabel":"string\u003cdate-time>"},"external_id":{"type":"string","uniqueKey":"appointments.items.[INDEX].external_id","typeLabel":"string"},"id":{"type":"string","format":"uuid","uniqueKey":"appointments.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"notes":{"type":"string","uniqueKey":"appointments.items.[INDEX].notes","typeLabel":"string"},"public_id":{"type":"string","uniqueKey":"appointments.items.[INDEX].public_id","typeLabel":"string"},"resource_color":{"type":"string","uniqueKey":"appointments.items.[INDEX].resource_color","typeLabel":"string"},"resource_id":{"type":"string","format":"uuid","uniqueKey":"appointments.items.[INDEX].resource_id","typeLabel":"string\u003cuuid>"},"resource_name":{"type":"string","uniqueKey":"appointments.items.[INDEX].resource_name","typeLabel":"string"},"resource_type":{"type":"string","uniqueKey":"appointments.items.[INDEX].resource_type","typeLabel":"string"},"service_color":{"type":"string","uniqueKey":"appointments.items.[INDEX].service_color","typeLabel":"string"},"service_currency":{"type":"string","uniqueKey":"appointments.items.[INDEX].service_currency","typeLabel":"string"},"service_description":{"type":"string","uniqueKey":"appointments.items.[INDEX].service_description","typeLabel":"string"},"service_id":{"type":"string","format":"uuid","uniqueKey":"appointments.items.[INDEX].service_id","typeLabel":"string\u003cuuid>"},"service_name":{"type":"string","uniqueKey":"appointments.items.[INDEX].service_name","typeLabel":"string"},"service_price":{"type":"number","uniqueKey":"appointments.items.[INDEX].service_price","typeLabel":"number"},"source":{"type":"string","uniqueKey":"appointments.items.[INDEX].source","typeLabel":"string"},"starts_at":{"type":"string","format":"date-time","uniqueKey":"appointments.items.[INDEX].starts_at","typeLabel":"string\u003cdate-time>"},"status":{"type":"string","uniqueKey":"appointments.items.[INDEX].status","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"appointments.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"version":{"type":"integer","uniqueKey":"appointments.items.[INDEX].version","typeLabel":"integer"}},"uniqueKey":"appointments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"appointments","typeLabel":"object[]"},"availability_exceptions":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"integer","uniqueKey":"availability_exceptions.items.[INDEX].account_id","typeLabel":"integer"},"created_at":{"type":"string","format":"date-time","uniqueKey":"availability_exceptions.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"ends_at":{"type":"string","format":"date-time","uniqueKey":"availability_exceptions.items.[INDEX].ends_at","typeLabel":"string\u003cdate-time>"},"id":{"type":"string","format":"uuid","uniqueKey":"availability_exceptions.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"kind":{"type":"string","uniqueKey":"availability_exceptions.items.[INDEX].kind","typeLabel":"string"},"reason":{"type":"string","uniqueKey":"availability_exceptions.items.[INDEX].reason","typeLabel":"string"},"resource_id":{"type":"string","format":"uuid","uniqueKey":"availability_exceptions.items.[INDEX].resource_id","typeLabel":"string\u003cuuid>"},"starts_at":{"type":"string","format":"date-time","uniqueKey":"availability_exceptions.items.[INDEX].starts_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"availability_exceptions.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"availability_exceptions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"availability_exceptions","typeLabel":"object[]"},"availability_rules":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"integer","uniqueKey":"availability_rules.items.[INDEX].account_id","typeLabel":"integer"},"created_at":{"type":"string","format":"date-time","uniqueKey":"availability_rules.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"day_of_week":{"type":"integer","uniqueKey":"availability_rules.items.[INDEX].day_of_week","typeLabel":"integer"},"effective_from":{"type":"string","format":"date","uniqueKey":"availability_rules.items.[INDEX].effective_from","typeLabel":"string\u003cdate>"},"effective_to":{"type":"string","format":"date","uniqueKey":"availability_rules.items.[INDEX].effective_to","typeLabel":"string\u003cdate>"},"end_minute":{"type":"integer","uniqueKey":"availability_rules.items.[INDEX].end_minute","typeLabel":"integer"},"id":{"type":"string","format":"uuid","uniqueKey":"availability_rules.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"is_active":{"type":"boolean","uniqueKey":"availability_rules.items.[INDEX].is_active","typeLabel":"boolean"},"resource_id":{"type":"string","format":"uuid","uniqueKey":"availability_rules.items.[INDEX].resource_id","typeLabel":"string\u003cuuid>"},"start_minute":{"type":"integer","uniqueKey":"availability_rules.items.[INDEX].start_minute","typeLabel":"integer"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"availability_rules.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"availability_rules.items.[INDEX]","typeLabel":"object"},"uniqueKey":"availability_rules","typeLabel":"object[]"},"resources":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"integer","example":3,"uniqueKey":"resources.items.[INDEX].account_id","typeLabel":"integer"},"color":{"type":"string","uniqueKey":"resources.items.[INDEX].color","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","uniqueKey":"resources.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"description":{"type":"string","uniqueKey":"resources.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","format":"uuid","uniqueKey":"resources.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"is_active":{"type":"boolean","uniqueKey":"resources.items.[INDEX].is_active","typeLabel":"boolean"},"metadata":{"type":"object","uniqueKey":"resources.items.[INDEX].metadata","typeLabel":"object"},"name":{"type":"string","uniqueKey":"resources.items.[INDEX].name","typeLabel":"string"},"position":{"type":"integer","uniqueKey":"resources.items.[INDEX].position","typeLabel":"integer"},"resource_type":{"type":"string","uniqueKey":"resources.items.[INDEX].resource_type","typeLabel":"string"},"timezone":{"type":"string","uniqueKey":"resources.items.[INDEX].timezone","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"resources.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"resources.items.[INDEX]","typeLabel":"object"},"uniqueKey":"resources","typeLabel":"object[]"},"service_resources":{"type":"array","items":{"type":"object","properties":{"resource_id":{"type":"string","format":"uuid","uniqueKey":"service_resources.items.[INDEX].resource_id","typeLabel":"string\u003cuuid>"},"service_id":{"type":"string","format":"uuid","uniqueKey":"service_resources.items.[INDEX].service_id","typeLabel":"string\u003cuuid>"}},"uniqueKey":"service_resources.items.[INDEX]","typeLabel":"object"},"uniqueKey":"service_resources","typeLabel":"object[]"},"services":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"integer","example":3,"uniqueKey":"services.items.[INDEX].account_id","typeLabel":"integer"},"buffer_after_minutes":{"type":"integer","uniqueKey":"services.items.[INDEX].buffer_after_minutes","typeLabel":"integer"},"buffer_before_minutes":{"type":"integer","uniqueKey":"services.items.[INDEX].buffer_before_minutes","typeLabel":"integer"},"color":{"type":"string","uniqueKey":"services.items.[INDEX].color","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","uniqueKey":"services.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"currency":{"type":"string","uniqueKey":"services.items.[INDEX].currency","typeLabel":"string"},"description":{"type":"string","uniqueKey":"services.items.[INDEX].description","typeLabel":"string"},"duration_minutes":{"type":"integer","uniqueKey":"services.items.[INDEX].duration_minutes","typeLabel":"integer"},"id":{"type":"string","format":"uuid","uniqueKey":"services.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"is_active":{"type":"boolean","uniqueKey":"services.items.[INDEX].is_active","typeLabel":"boolean"},"metadata":{"type":"object","uniqueKey":"services.items.[INDEX].metadata","typeLabel":"object"},"name":{"type":"string","uniqueKey":"services.items.[INDEX].name","typeLabel":"string"},"position":{"type":"integer","uniqueKey":"services.items.[INDEX].position","typeLabel":"integer"},"price":{"type":"number","uniqueKey":"services.items.[INDEX].price","typeLabel":"number"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"services.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"services.items.[INDEX]","typeLabel":"object"},"uniqueKey":"services","typeLabel":"object[]"},"settings":{"type":"object","properties":{"account_id":{"type":"integer","example":3,"uniqueKey":"settings.account_id","typeLabel":"integer"},"booking_mode":{"type":"string","enum":["native","external"],"example":"native","uniqueKey":"settings.booking_mode","typeLabel":"enum\u003cstring>"},"cancellation_notice_minutes":{"type":"integer","example":120,"uniqueKey":"settings.cancellation_notice_minutes","typeLabel":"integer"},"confirmation_mode":{"type":"string","enum":["manual","automatic"],"example":"automatic","uniqueKey":"settings.confirmation_mode","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","format":"date-time","uniqueKey":"settings.created_at","typeLabel":"string\u003cdate-time>"},"default_view":{"type":"string","enum":["day","week","month","list"],"example":"week","uniqueKey":"settings.default_view","typeLabel":"enum\u003cstring>"},"maximum_advance_days":{"type":"integer","example":90,"uniqueKey":"settings.maximum_advance_days","typeLabel":"integer"},"minimum_notice_minutes":{"type":"integer","example":60,"uniqueKey":"settings.minimum_notice_minutes","typeLabel":"integer"},"native_enabled":{"type":"boolean","example":true,"uniqueKey":"settings.native_enabled","typeLabel":"boolean"},"resource_label":{"type":"string","example":"Doctor","uniqueKey":"settings.resource_label","typeLabel":"string"},"slot_interval_minutes":{"type":"integer","enum":[5,10,15,20,30,45,60,90,120],"example":15,"uniqueKey":"settings.slot_interval_minutes","typeLabel":"enum\u003cinteger>"},"timezone":{"type":"string","example":"Asia/Riyadh","uniqueKey":"settings.timezone","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"settings.updated_at","typeLabel":"string\u003cdate-time>"},"week_starts_on":{"type":"integer","maximum":6,"minimum":0,"example":0,"uniqueKey":"settings.week_starts_on","typeLabel":"integer"}},"uniqueKey":"settings","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"appointments":[{"account_id":123,"buffer_after_minutes":123,"buffer_before_minutes":123,"busy_ends_at":"2023-11-07T05:31:56Z","busy_starts_at":"2023-11-07T05:31:56Z","cancellation_reason":"\u003cstring>","cancelled_at":"2023-11-07T05:31:56Z","completed_at":"2023-11-07T05:31:56Z","confirmed_at":"2023-11-07T05:31:56Z","contact_id":123,"conversation_id":123,"created_at":"2023-11-07T05:31:56Z","created_by_ai_agent_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","created_by_user_id":123,"customer_email":"\u003cstring>","customer_name":"\u003cstring>","customer_phone":"\u003cstring>","duration_minutes":123,"ends_at":"2023-11-07T05:31:56Z","external_id":"\u003cstring>","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","notes":"\u003cstring>","public_id":"\u003cstring>","resource_color":"\u003cstring>","resource_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","resource_name":"\u003cstring>","resource_type":"\u003cstring>","service_color":"\u003cstring>","service_currency":"\u003cstring>","service_description":"\u003cstring>","service_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","service_name":"\u003cstring>","service_price":123,"source":"\u003cstring>","starts_at":"2023-11-07T05:31:56Z","status":"\u003cstring>","updated_at":"2023-11-07T05:31:56Z","version":123}],"availability_exceptions":[{"account_id":123,"created_at":"2023-11-07T05:31:56Z","ends_at":"2023-11-07T05:31:56Z","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","kind":"\u003cstring>","reason":"\u003cstring>","resource_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","starts_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"}],"availability_rules":[{"account_id":123,"created_at":"2023-11-07T05:31:56Z","day_of_week":123,"effective_from":"2023-12-25","effective_to":"2023-12-25","end_minute":123,"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","is_active":true,"resource_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","start_minute":123,"updated_at":"2023-11-07T05:31:56Z"}],"resources":[{"account_id":3,"color":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","description":"\u003cstring>","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","is_active":true,"metadata":{},"name":"\u003cstring>","position":123,"resource_type":"\u003cstring>","timezone":"\u003cstring>","updated_at":"2023-11-07T05:31:56Z"}],"service_resources":[{"resource_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","service_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}],"services":[{"account_id":3,"buffer_after_minutes":123,"buffer_before_minutes":123,"color":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","currency":"\u003cstring>","description":"\u003cstring>","duration_minutes":123,"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","is_active":true,"metadata":{},"name":"\u003cstring>","position":123,"price":123,"updated_at":"2023-11-07T05:31:56Z"}],"settings":{"account_id":3,"booking_mode":"native","cancellation_notice_minutes":120,"confirmation_mode":"automatic","created_at":"2023-11-07T05:31:56Z","default_view":"week","maximum_advance_days":90,"minimum_notice_minutes":60,"native_enabled":true,"resource_label":"Doctor","slot_interval_minutes":15,"timezone":"Asia/Riyadh","updated_at":"2023-11-07T05:31:56Z","week_starts_on":0}}}},"exampleType":"generated"}},"exampleType":"generated"},"3031906d-e09a-4acf-a74c-19e12d2a5767":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"limit":{"type":"string","uniqueKey":"limit","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","limit":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"dddd326f-d8c0-4264-874d-afcb2a67aa14":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"limit":{"type":"string","uniqueKey":"limit","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","limit":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"8bfc1742-4f5e-4f99-8139-1456326bba3c":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"limit":{"type":"string","uniqueKey":"limit","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","limit":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"5d63e487-5b86-4b99-b10e-31034834d32c":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"60 seconds before retrying after the API key quota is exceeded","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"limit":{"type":"string","uniqueKey":"limit","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","limit":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"8c50086c-99b2-467a-ab74-af466d0972b0":{"description":"Service Unavailable","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"limit":{"type":"string","uniqueKey":"limit","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","limit":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f0ca67ab-bf38-40f0-8714-2b58cc459876":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Your personal access token where supported, or a scoped API key (`hc_…`) created inside HueChat at Account → Developer API. Send it as `Authorization: Bearer \u003ctoken>`.","scopes":[]}}},"servers":{"4b252eaf-e4f5-4562-8dc6-7e1f203e966d":{"url":"https://app.huechat.ai","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Your personal access token where supported, or a scoped API key (`hc_…`) created inside HueChat at Account → Developer API. Send it as `Authorization: Bearer \u003ctoken>`.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your personal access token where supported, or a scoped API key (`hc_…`) created inside HueChat at Account → Developer API. Send it as `Authorization: Bearer \u003ctoken>`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"huechat-ai","siteName":"HueChat","title":"List appointments and catalog - HueChat","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/appointments/list-appointments-and-catalog","matchLevel":0},"ar":{"href":"/api-reference/appointments/list-appointments-and-catalog","matchLevel":0}}},"lastModified":"2026-10-01T00:27:23.661Z","originalFileLocation":"api-reference/appointments/list-appointments-and-catalog.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Requires appointments:read. Results are restricted to the API key\u0026#x27;s account and an RFC3339 range of at most 366 days. Use the dedicated catalog, resources, services and availability endpoints for focused integration reads.\">\u003cmeta data-mint-head name=\"application-name\" content=\"HueChat\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/huechat-ai/6n_0ERyKzj8iTviF/_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/huechat-ai/6n_0ERyKzj8iTviF/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/huechat-ai/6n_0ERyKzj8iTviF/_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/huechat-ai/6n_0ERyKzj8iTviF/_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/huechat-ai/6n_0ERyKzj8iTviF/_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/huechat-ai/6n_0ERyKzj8iTviF/_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/huechat-ai/6n_0ERyKzj8iTviF/_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/huechat-ai/6n_0ERyKzj8iTviF/_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/huechat-ai/6n_0ERyKzj8iTviF/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List appointments and catalog - HueChat\">\u003cmeta data-mint-head property=\"og:description\" content=\"Requires appointments:read. Results are restricted to the API key\u0026#x27;s account and an RFC3339 range of at most 366 days. Use the dedicated catalog, resources, services and availability endpoints for focused integration reads.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"HueChat\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.huechat.ai/api-reference/appointments/list-appointments-and-catalog\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://huechat-ai.mintlify.app/_mintlify/api/og/v2?division=Appointments\u0026amp;title=List+appointments+and+catalog\u0026amp;description=Requires+appointments%3Aread.+Results+are+restricted+to+the+API+key%27s+account+and+an+RFC3339+range+of+at+most+366+days.+Use+the+dedicated+catalog%2C+resources%2C+serv\u0026amp;theme=6e0f5b69c8d5212387bdf6b9\u0026amp;signature=d1719ce80d0f8276ce47f7ae1533a496045ea50460f61fc0ddba53aa0078c2d8\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List appointments and catalog - HueChat\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Requires appointments:read. Results are restricted to the API key\u0026#x27;s account and an RFC3339 range of at most 366 days. Use the dedicated catalog, resources, services and availability endpoints for focused integration reads.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://huechat-ai.mintlify.app/_mintlify/api/og/v2?division=Appointments\u0026amp;title=List+appointments+and+catalog\u0026amp;description=Requires+appointments%3Aread.+Results+are+restricted+to+the+API+key%27s+account+and+an+RFC3339+range+of+at+most+366+days.+Use+the+dedicated+catalog%2C+resources%2C+serv\u0026amp;theme=6e0f5b69c8d5212387bdf6b9\u0026amp;signature=d1719ce80d0f8276ce47f7ae1533a496045ea50460f61fc0ddba53aa0078c2d8\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/huechat-ai/6n_0ERyKzj8iTviF/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"HueChat\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6C5CE7\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.huechat.ai/api-reference/appointments/list-appointments-and-catalog\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/appointments/list-appointments-and-catalog.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.huechat.ai/#organization\",\"name\":\"HueChat\",\"url\":\"https://developers.huechat.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/huechat-ai/x4DYXX8dNO7UqvMj/logo/light.png?fit=max\u0026auto=format\u0026n=x4DYXX8dNO7UqvMj\u0026q=85\u0026s=aeae34b3f7d708b952ad3c7eade2b0b0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.huechat.ai#website\",\"name\":\"HueChat\",\"url\":\"https://developers.huechat.ai\",\"publisher\":{\"@id\":\"https://developers.huechat.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.huechat.ai/api-reference/appointments/list-appointments-and-catalog#webpage\",\"url\":\"https://developers.huechat.ai/api-reference/appointments/list-appointments-and-catalog\",\"name\":\"List appointments and catalog\",\"description\":\"Requires appointments:read. Results are restricted to the API key's account and an RFC3339 range of at most 366 days. Use the dedicated catalog, resources, services and availability endpoints for focused integration reads.\",\"dateModified\":\"2026-10-01T00:27:23.661Z\",\"isPartOf\":{\"@id\":\"https://developers.huechat.ai#website\"},\"breadcrumb\":{\"@id\":\"https://developers.huechat.ai/api-reference/appointments/list-appointments-and-catalog#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.huechat.ai/api-reference/appointments/list-appointments-and-catalog#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://developers.huechat.ai/api-reference/ai-agents/list-ai-agents\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List appointments and catalog\",\"item\":\"https://developers.huechat.ai/api-reference/appointments/list-appointments-and-catalog\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.huechat.ai/api-reference/appointments/list-appointments-and-catalog#apireference\",\"headline\":\"List appointments and catalog\",\"name\":\"List appointments and catalog\",\"description\":\"Requires appointments:read. Results are restricted to the API key's account and an RFC3339 range of at most 366 days. Use the dedicated catalog, resources, services and availability endpoints for focused integration reads.\",\"url\":\"https://developers.huechat.ai/api-reference/appointments/list-appointments-and-catalog\",\"mainEntityOfPage\":{\"@id\":\"https://developers.huechat.ai/api-reference/appointments/list-appointments-and-catalog#webpage\"},\"dateModified\":\"2026-10-01T00:27:23.661Z\",\"publisher\":{\"@id\":\"https://developers.huechat.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.huechat.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"HueChat\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"HueChat","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Guide","pages":[{"title":"Guide","href":"/introduction"}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API reference","href":"/api-reference/overview"}]},{"group":"Endpoints","pages":[{"group":"AI Agents","pages":[{"title":"List AI agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/ai-agents","href":"/api-reference/ai-agents/list-ai-agents"},{"title":"Create AI agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents","href":"/api-reference/ai-agents/create-ai-agent"},{"title":"Create AI agent from template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/from-template","href":"/api-reference/ai-agents/create-ai-agent-from-template"},{"title":"List agent templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/ai-agents/templates","href":"/api-reference/ai-agents/list-agent-templates"},{"title":"Preview TTS voice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/tts-preview","href":"/api-reference/ai-agents/preview-tts-voice"},{"title":"List TTS voices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/ai-agents/tts-voices","href":"/api-reference/ai-agents/list-tts-voices"},{"title":"Get AI agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/ai-agents/{agentId}","href":"/api-reference/ai-agents/get-ai-agent"},{"title":"Update AI agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/ai-agents/{agentId}","href":"/api-reference/ai-agents/update-ai-agent"},{"title":"Delete AI agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/ai-agents/{agentId}","href":"/api-reference/ai-agents/delete-ai-agent"},{"title":"Publish AI agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/{agentId}/publish","href":"/api-reference/ai-agents/publish-ai-agent"},{"title":"Get AI agent stats","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/ai-agents/{agentId}/stats","href":"/api-reference/ai-agents/get-ai-agent-stats"},{"title":"Test AI agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/{agentId}/test","href":"/api-reference/ai-agents/test-ai-agent"},{"title":"Clear test history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/ai-agents/{agentId}/test","href":"/api-reference/ai-agents/clear-test-history"},{"title":"Toggle AI agent active state","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/{agentId}/toggle","href":"/api-reference/ai-agents/toggle-ai-agent-active-state"},{"title":"List agent versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/ai-agents/{agentId}/versions","href":"/api-reference/ai-agents/list-agent-versions"},{"title":"Rollback agent version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/{agentId}/versions/{versionId}/rollback","href":"/api-reference/ai-agents/rollback-agent-version"},{"title":"Get AI analytics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/ai-analytics","href":"/api-reference/ai-agents/get-ai-analytics"},{"title":"Get conversation handoff status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/conversations/{convID}/handoff","href":"/api-reference/ai-agents/get-conversation-handoff-status"},{"title":"Set conversation handoff status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/conversations/{convID}/handoff","href":"/api-reference/ai-agents/set-conversation-handoff-status"},{"title":"List inboxes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/inboxes","href":"/api-reference/ai-agents/list-inboxes"}]},{"group":"Forms","pages":[{"title":"Generate a validated form preview through Agent AI","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/{agentId}/forms/generate","href":"/api-reference/forms/generate-a-validated-form-preview-through-agent-ai"},{"title":"Get monthly AI form draft allowance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/ai-agents/{agentId}/forms/generation-usage","href":"/api-reference/forms/get-monthly-ai-form-draft-allowance"},{"title":"List workspace forms","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/forms","href":"/api-reference/forms/list-workspace-forms"},{"title":"Create a draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/forms","href":"/api-reference/forms/create-a-draft"},{"title":"Generate a validated form preview in Forms","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/forms/ai/generate","href":"/api-reference/forms/generate-a-validated-form-preview-in-forms"},{"title":"Get monthly AI form draft allowance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/forms/ai/generation-usage","href":"/api-reference/forms/get-monthly-ai-form-draft-allowance-1"},{"title":"Read a form draft and metadata","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/forms/{formId}","href":"/api-reference/forms/read-a-form-draft-and-metadata"},{"title":"Save a draft with optimistic version check","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/accounts/{accountId}/forms/{formId}","href":"/api-reference/forms/save-a-draft-with-optimistic-version-check"},{"title":"Archive reversibly","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/forms/{formId}/archive","href":"/api-reference/forms/archive-reversibly"},{"title":"Upload native design media","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/forms/{formId}/assets","href":"/api-reference/forms/upload-native-design-media"},{"title":"Read a native form asset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/forms/{formId}/assets/{assetId}","href":"/api-reference/forms/read-a-native-form-asset"},{"title":"Close a published form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/forms/{formId}/close","href":"/api-reference/forms/close-a-published-form"},{"title":"Track private invitation delivery and completion","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/forms/{formId}/invitations","href":"/api-reference/forms/track-private-invitation-delivery-and-completion"},{"title":"Create an identity-bound recipient invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/forms/{formId}/invitations","href":"/api-reference/forms/create-an-identity-bound-recipient-invitation"},{"title":"List administrative invitation records","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/forms/{formId}/invitations/manage","href":"/api-reference/forms/list-administrative-invitation-records"},{"title":"Revoke an active invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/forms/{formId}/invitations/{invitationId}/revoke","href":"/api-reference/forms/revoke-an-active-invitation"},{"title":"Publish an immutable form version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/forms/{formId}/publish","href":"/api-reference/forms/publish-an-immutable-form-version"},{"title":"Form performance and question summaries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/forms/{formId}/reports","href":"/api-reference/forms/form-performance-and-question-summaries"},{"title":"List partial and completed responses","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/forms/{formId}/responses","href":"/api-reference/forms/list-partial-and-completed-responses"},{"title":"Export filtered response CSV","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/forms/{formId}/responses/export.csv","href":"/api-reference/forms/export-filtered-response-csv"},{"title":"Restore to closed if previously published, otherwise draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/forms/{formId}/restore","href":"/api-reference/forms/restore-to-closed-if-previously-published-otherwise-draft"},{"title":"Rotate opaque public code. Earlier public and recipient URLs stop resolving","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/forms/{formId}/rotate-link","href":"/api-reference/forms/rotate-opaque-public-code-earlier-public-and-recipient-urls-stop-resolving"},{"title":"List published immutable versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/forms/{formId}/versions","href":"/api-reference/forms/list-published-immutable-versions"},{"title":"Read a native form asset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/form-assets/{assetId}","href":"/api-reference/forms/read-a-native-form-asset-1"},{"title":"Open a published form and obtain a signed session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/forms/{publicCode}","href":"/api-reference/forms/open-a-published-form-and-obtain-a-signed-session"},{"title":"Get a bounded respondent AI answer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/forms/{publicCode}/ai/respond","href":"/api-reference/forms/get-a-bounded-respondent-ai-answer"},{"title":"Upload a signed respondent attachment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/forms/{publicCode}/assets","href":"/api-reference/forms/upload-a-signed-respondent-attachment"},{"title":"Record a respondent funnel event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/forms/{publicCode}/events","href":"/api-reference/forms/record-a-respondent-funnel-event"},{"title":"Suggest saved CDP answers with explicit opt-in","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/forms/{publicCode}/prefill","href":"/api-reference/forms/suggest-saved-cdp-answers-with-explicit-opt-in"},{"title":"Save partial or completed answers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/forms/{publicCode}/responses","href":"/api-reference/forms/save-partial-or-completed-answers"},{"title":"Book a native appointment for this question","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/forms/{publicCode}/schedule/book","href":"/api-reference/forms/book-a-native-appointment-for-this-question"},{"title":"Get native appointment availability","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/forms/{publicCode}/schedule/slots","href":"/api-reference/forms/get-native-appointment-availability"}]},{"group":"Knowledge","pages":[{"title":"Add knowledge text","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/{agentId}/knowledge/text","href":"/api-reference/knowledge/add-knowledge-text"},{"title":"Upload knowledge file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/{agentId}/knowledge/upload","href":"/api-reference/knowledge/upload-knowledge-file"},{"title":"Add knowledge URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/{agentId}/knowledge/url","href":"/api-reference/knowledge/add-knowledge-url"},{"title":"Get knowledge source","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/ai-agents/{agentId}/knowledge/{sourceId}","href":"/api-reference/knowledge/get-knowledge-source"},{"title":"Update knowledge source","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/ai-agents/{agentId}/knowledge/{sourceId}","href":"/api-reference/knowledge/update-knowledge-source"},{"title":"Delete knowledge source","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/ai-agents/{agentId}/knowledge/{sourceId}","href":"/api-reference/knowledge/delete-knowledge-source"},{"title":"Upload knowledge image","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/{agentId}/knowledge/{sourceId}/images","href":"/api-reference/knowledge/upload-knowledge-image"},{"title":"Delete knowledge image","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/ai-agents/{agentId}/knowledge/{sourceId}/images/{index}","href":"/api-reference/knowledge/delete-knowledge-image"},{"title":"Reindex knowledge source","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/{agentId}/knowledge/{sourceId}/reindex","href":"/api-reference/knowledge/reindex-knowledge-source"},{"title":"Get RAG indexing status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/ai-agents/{agentId}/rag-status","href":"/api-reference/knowledge/get-rag-indexing-status"},{"title":"Reindex all knowledge sources","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/{agentId}/reindex-all","href":"/api-reference/knowledge/reindex-all-knowledge-sources"},{"title":"Search knowledge base","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/{agentId}/search-knowledge","href":"/api-reference/knowledge/search-knowledge-base"},{"title":"List all knowledge sources","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/knowledge-sources","href":"/api-reference/knowledge/list-all-knowledge-sources"},{"title":"Create knowledge source (standalone)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/knowledge-sources","href":"/api-reference/knowledge/create-knowledge-source-standalone"},{"title":"Get knowledge source (standalone)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/knowledge-sources/{sourceId}","href":"/api-reference/knowledge/get-knowledge-source-standalone"},{"title":"Delete knowledge source (standalone)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/knowledge-sources/{sourceId}","href":"/api-reference/knowledge/delete-knowledge-source-standalone"},{"title":"Update knowledge source (standalone)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/accounts/{accountId}/knowledge-sources/{sourceId}","href":"/api-reference/knowledge/update-knowledge-source-standalone"},{"title":"Reindex knowledge source (standalone)","description":"Re-indexes a knowledge source by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/knowledge-sources/{sourceId}/reprocess","href":"/api-reference/knowledge/reindex-knowledge-source-standalone"}]},{"group":"Appointments","pages":[{"title":"List appointments and catalog","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments","href":"/api-reference/appointments/list-appointments-and-catalog"},{"title":"Create or safely replay an appointment","description":"Requires appointments:write. Select the appointment type by service_id or exact service_name; select a resource by resource_id/resource_name or omit it to use an eligible available resource. Supply starts_at in RFC3339 or local date plus time in the account timezone. The configured service duration determines ends_at, so ends_at is optional. The requested time is revalidated against the same rules returned by the slot endpoint. Supplying contact_id also requires contacts:read; supplying deal_id also requires deals:write and UUID selectors. API-key callers must provide external_id; retrying the identical request returns the existing appointment without creating a duplicate. A REST key with appointments:sync on an account approved for a scheduling system connection is treated like PUT /appointments/external/{externalId}: the booking is stored as the system has it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/appointments","href":"/api-reference/appointments/create-or-safely-replay-an-appointment"},{"title":"List appointment availability","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/availability","href":"/api-reference/appointments/list-appointment-availability"},{"title":"Create availability exception","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/appointments/availability/exceptions","href":"/api-reference/appointments/create-availability-exception"},{"title":"Delete availability exception","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/appointments/availability/exceptions/{exceptionId}","href":"/api-reference/appointments/delete-availability-exception"},{"title":"Set weekly availability rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/appointments/availability/rules","href":"/api-reference/appointments/set-weekly-availability-rule"},{"title":"Replace weekly availability rules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/appointments/availability/rules/bulk","href":"/api-reference/appointments/replace-weekly-availability-rules"},{"title":"Get appointment catalog","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/catalog","href":"/api-reference/appointments/get-appointment-catalog"},{"title":"Get appointment by external ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/external/{externalId}","href":"/api-reference/appointments/get-appointment-by-external-id"},{"title":"Sync one appointment from a scheduling system","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/appointments/external/{externalId}","href":"/api-reference/appointments/sync-one-appointment-from-a-scheduling-system"},{"title":"Cancel a synced appointment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/appointments/external/{externalId}","href":"/api-reference/appointments/cancel-a-synced-appointment"},{"title":"Import or safely replay a historical appointment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/appointments/history","href":"/api-reference/appointments/import-or-safely-replay-a-historical-appointment"},{"title":"Get appointment reports","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/reports","href":"/api-reference/appointments/get-appointment-reports"},{"title":"List appointment resources","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/resources","href":"/api-reference/appointments/list-appointment-resources"},{"title":"Create appointment resource","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/appointments/resources","href":"/api-reference/appointments/create-appointment-resource"},{"title":"Get appointment resource","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/resources/{resourceId}","href":"/api-reference/appointments/get-appointment-resource"},{"title":"Update appointment resource","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/appointments/resources/{resourceId}","href":"/api-reference/appointments/update-appointment-resource"},{"title":"Archive appointment resource","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/appointments/resources/{resourceId}","href":"/api-reference/appointments/archive-appointment-resource"},{"title":"Restore appointment resource","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/appointments/resources/{resourceId}/restore","href":"/api-reference/appointments/restore-appointment-resource"},{"title":"List appointment services","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/services","href":"/api-reference/appointments/list-appointment-services"},{"title":"Create appointment service","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/appointments/services","href":"/api-reference/appointments/create-appointment-service"},{"title":"Get appointment service","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/services/{serviceId}","href":"/api-reference/appointments/get-appointment-service"},{"title":"Update appointment service","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/appointments/services/{serviceId}","href":"/api-reference/appointments/update-appointment-service"},{"title":"Archive appointment service","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/appointments/services/{serviceId}","href":"/api-reference/appointments/archive-appointment-service"},{"title":"Assign resources to appointment service","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/appointments/services/{serviceId}/resources","href":"/api-reference/appointments/assign-resources-to-appointment-service"},{"title":"Restore appointment service","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/appointments/services/{serviceId}/restore","href":"/api-reference/appointments/restore-appointment-service"},{"title":"Get appointment settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/settings","href":"/api-reference/appointments/get-appointment-settings"},{"title":"Update appointment settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/appointments/settings","href":"/api-reference/appointments/update-appointment-settings"},{"title":"List available appointment slots","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/slots","href":"/api-reference/appointments/list-available-appointment-slots"},{"title":"Get appointment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/{id}","href":"/api-reference/appointments/get-appointment"},{"title":"Update appointment details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/accounts/{accountId}/appointments/{id}","href":"/api-reference/appointments/update-appointment-details"},{"title":"Reschedule appointment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/accounts/{accountId}/appointments/{id}/schedule","href":"/api-reference/appointments/reschedule-appointment"},{"title":"Update appointment status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/accounts/{accountId}/appointments/{id}/status","href":"/api-reference/appointments/update-appointment-status"},{"title":"List synced appointments for reconciliation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/sync","href":"/api-reference/appointments/list-synced-appointments-for-reconciliation"},{"title":"Sync a batch of appointments from a scheduling system","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/appointments/sync","href":"/api-reference/appointments/sync-a-batch-of-appointments-from-a-scheduling-system"},{"title":"Scheduling system connection status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/sync/status","href":"/api-reference/appointments/scheduling-system-connection-status"},{"title":"Sync a FHIR R4 batch Bundle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/fhir/R4","href":"/api-reference/appointments/sync-a-fhir-r4-batch-bundle"},{"title":"Read a synced FHIR R4 Appointment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/fhir/R4/Appointment/{fhirId}","href":"/api-reference/appointments/read-a-synced-fhir-r4-appointment"},{"title":"Sync a FHIR R4 Appointment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/fhir/R4/Appointment/{fhirId}","href":"/api-reference/appointments/sync-a-fhir-r4-appointment"},{"title":"Delete a synced FHIR R4 Appointment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/fhir/R4/Appointment/{fhirId}","href":"/api-reference/appointments/delete-a-synced-fhir-r4-appointment"},{"title":"FHIR R4 capability statement for scheduling systems","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/fhir/R4/metadata","href":"/api-reference/appointments/fhir-r4-capability-statement-for-scheduling-systems"}]},{"group":"Appointment reminders","pages":[{"title":"List reminder delivery receipts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/reminder-deliveries","href":"/api-reference/appointment-reminders/list-reminder-delivery-receipts"},{"title":"List appointment reminder rules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/reminders","href":"/api-reference/appointment-reminders/list-appointment-reminder-rules"},{"title":"Create an appointment reminder with an optional published form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/appointments/reminders","href":"/api-reference/appointment-reminders/create-an-appointment-reminder-with-an-optional-published-form"},{"title":"Update a reminder and its optional form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/appointments/reminders/{reminderId}","href":"/api-reference/appointment-reminders/update-a-reminder-and-its-optional-form"},{"title":"Disable a reminder rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/appointments/reminders/{reminderId}","href":"/api-reference/appointment-reminders/disable-a-reminder-rule"}]},{"group":"Broadcasts","pages":[{"title":"List broadcasts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/broadcasts","href":"/api-reference/broadcasts/list-broadcasts"},{"title":"Create broadcast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/broadcasts","href":"/api-reference/broadcasts/create-broadcast"},{"title":"Broadcast reports","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/broadcasts/reports","href":"/api-reference/broadcasts/broadcast-reports"},{"title":"Get broadcast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/broadcasts/{broadcastId}","href":"/api-reference/broadcasts/get-broadcast"},{"title":"Update broadcast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/broadcasts/{broadcastId}","href":"/api-reference/broadcasts/update-broadcast"},{"title":"Delete broadcast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/broadcasts/{broadcastId}","href":"/api-reference/broadcasts/delete-broadcast"},{"title":"Cancel broadcast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/broadcasts/{broadcastId}/cancel","href":"/api-reference/broadcasts/cancel-broadcast"},{"title":"List broadcast recipients","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/broadcasts/{broadcastId}/recipients","href":"/api-reference/broadcasts/list-broadcast-recipients"},{"title":"Send broadcast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/broadcasts/{broadcastId}/send","href":"/api-reference/broadcasts/send-broadcast"},{"title":"Upload CSV recipients","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/broadcasts/{broadcastId}/upload-csv","href":"/api-reference/broadcasts/upload-csv-recipients"}]},{"group":"Customer CDP","pages":[{"title":"Get Customer CDP access","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/access","href":"/api-reference/customer-cdp/get-customer-cdp-access"},{"title":"List audiences","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/audiences","href":"/api-reference/customer-cdp/list-audiences"},{"title":"Create an audience","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/audiences","href":"/api-reference/customer-cdp/create-an-audience"},{"title":"Preview audience customers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/audiences/preview","href":"/api-reference/customer-cdp/preview-audience-customers"},{"title":"Update an audience","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/cdp/audiences/{audienceId}","href":"/api-reference/customer-cdp/update-an-audience"},{"title":"Delete an audience","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/cdp/audiences/{audienceId}","href":"/api-reference/customer-cdp/delete-an-audience"},{"title":"List saved audience customers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/audiences/{audienceId}/customers","href":"/api-reference/customer-cdp/list-saved-audience-customers"},{"title":"List advanced customer records","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/customers","href":"/api-reference/customer-cdp/list-advanced-customer-records"},{"title":"Get customer activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/customers/{contactId}/activity","href":"/api-reference/customer-cdp/get-customer-activity"},{"title":"List customer journeys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/journeys","href":"/api-reference/customer-cdp/list-customer-journeys"},{"title":"Create a customer journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/journeys","href":"/api-reference/customer-cdp/create-a-customer-journey"},{"title":"Get journey options","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/journeys/options","href":"/api-reference/customer-cdp/get-journey-options"},{"title":"Preview a customer journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/journeys/preview","href":"/api-reference/customer-cdp/preview-a-customer-journey"},{"title":"Get a customer journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/journeys/{workflowId}","href":"/api-reference/customer-cdp/get-a-customer-journey"},{"title":"Update a customer journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/cdp/journeys/{workflowId}","href":"/api-reference/customer-cdp/update-a-customer-journey"},{"title":"Publish a customer journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/journeys/{workflowId}/publish","href":"/api-reference/customer-cdp/publish-a-customer-journey"},{"title":"List journey runs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/journeys/{workflowId}/runs","href":"/api-reference/customer-cdp/list-journey-runs"},{"title":"Cancel a journey run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/journeys/{workflowId}/runs/{runId}/cancel","href":"/api-reference/customer-cdp/cancel-a-journey-run"},{"title":"Review an uncertain journey delivery","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/journeys/{workflowId}/runs/{runId}/review","href":"/api-reference/customer-cdp/review-an-uncertain-journey-delivery"},{"title":"List membership-capable inboxes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/membership/inboxes","href":"/api-reference/customer-cdp/list-membership-capable-inboxes"},{"title":"List memberships","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/membership/members","href":"/api-reference/customer-cdp/list-memberships"},{"title":"Get a membership","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/membership/members/{membershipId}","href":"/api-reference/customer-cdp/get-a-membership"},{"title":"Apply a membership action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/membership/members/{membershipId}/activity","href":"/api-reference/customer-cdp/apply-a-membership-action"},{"title":"Award membership points from an integration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/membership/members/{membershipId}/events","href":"/api-reference/customer-cdp/award-membership-points-from-an-integration"},{"title":"Create a verified member link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/membership/members/{membershipId}/member-link","href":"/api-reference/customer-cdp/create-a-verified-member-link"},{"title":"Fulfill a membership benefit receipt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/membership/members/{membershipId}/receipts/{receiptId}/fulfill","href":"/api-reference/customer-cdp/fulfill-a-membership-benefit-receipt"},{"title":"List membership programs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/membership/programs","href":"/api-reference/customer-cdp/list-membership-programs"},{"title":"Create a membership program","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/membership/programs","href":"/api-reference/customer-cdp/create-a-membership-program"},{"title":"Get a membership program","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/membership/programs/{programId}","href":"/api-reference/customer-cdp/get-a-membership-program"},{"title":"Update a membership program","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/cdp/membership/programs/{programId}","href":"/api-reference/customer-cdp/update-a-membership-program"},{"title":"Get membership program activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/membership/programs/{programId}/activity","href":"/api-reference/customer-cdp/get-membership-program-activity"},{"title":"Create a verified enrollment invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/membership/programs/{programId}/invites","href":"/api-reference/customer-cdp/create-a-verified-enrollment-invitation"},{"title":"List program members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/membership/programs/{programId}/members","href":"/api-reference/customer-cdp/list-program-members"},{"title":"Enroll a contact in a program","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/membership/programs/{programId}/members","href":"/api-reference/customer-cdp/enroll-a-contact-in-a-program"},{"title":"Check membership program readiness","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/membership/programs/{programId}/readiness","href":"/api-reference/customer-cdp/check-membership-program-readiness"},{"title":"Get CDP preferences","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/preferences","href":"/api-reference/customer-cdp/get-cdp-preferences"},{"title":"Update CDP preferences","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/cdp/preferences","href":"/api-reference/customer-cdp/update-cdp-preferences"},{"title":"List or search contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/contacts","href":"/api-reference/customer-cdp/list-or-search-contacts"},{"title":"Create contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/contacts","href":"/api-reference/customer-cdp/create-contact"},{"title":"Merge contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/contacts/merge","href":"/api-reference/customer-cdp/merge-contacts"},{"title":"Search contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/contacts/search","href":"/api-reference/customer-cdp/search-contacts"},{"title":"Get contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/contacts/{contactId}","href":"/api-reference/customer-cdp/get-contact"},{"title":"Update contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/accounts/{accountId}/contacts/{contactId}","href":"/api-reference/customer-cdp/update-contact"},{"title":"Record contact consent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/contacts/{contactId}/consent","href":"/api-reference/customer-cdp/record-contact-consent"},{"title":"Get contact CDP profile","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/contacts/{contactId}/profile","href":"/api-reference/customer-cdp/get-contact-cdp-profile"},{"title":"List contact CDP timeline","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/contacts/{contactId}/timeline","href":"/api-reference/customer-cdp/list-contact-cdp-timeline"}]},{"group":"Chat Menus","pages":[{"title":"List chat menus","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/chat-menus","href":"/api-reference/chat-menus/list-chat-menus"},{"title":"Create chat menu","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/chat-menus","href":"/api-reference/chat-menus/create-chat-menu"},{"title":"Get chat menu","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/chat-menus/{menuId}","href":"/api-reference/chat-menus/get-chat-menu"},{"title":"Update chat menu","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/chat-menus/{menuId}","href":"/api-reference/chat-menus/update-chat-menu"},{"title":"Delete chat menu","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/chat-menus/{menuId}","href":"/api-reference/chat-menus/delete-chat-menu"},{"title":"Duplicate chat menu","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/chat-menus/{menuId}/duplicate","href":"/api-reference/chat-menus/duplicate-chat-menu"},{"title":"Toggle chat menu","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/chat-menus/{menuId}/toggle","href":"/api-reference/chat-menus/toggle-chat-menu"}]},{"group":"Templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/templates","href":"/api-reference/templates/list-templates"},{"title":"Create template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/templates","href":"/api-reference/templates/create-template"},{"title":"AI-generate template content","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/templates/ai-generate","href":"/api-reference/templates/ai-generate-template-content"},{"title":"Template analytics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/templates/analytics/{templateId}","href":"/api-reference/templates/template-analytics"},{"title":"List WhatsApp inboxes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/templates/inboxes","href":"/api-reference/templates/list-whatsapp-inboxes"},{"title":"Resubmit template to Meta","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/templates/resubmit","href":"/api-reference/templates/resubmit-template-to-meta"},{"title":"Sync templates from Meta","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/templates/sync","href":"/api-reference/templates/sync-templates-from-meta"},{"title":"Upload template media","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/templates/upload-media","href":"/api-reference/templates/upload-template-media"},{"title":"Get template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/templates/{templateId}","href":"/api-reference/templates/get-template"},{"title":"Update template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/templates/{templateId}","href":"/api-reference/templates/update-template"},{"title":"Delete template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/templates/{templateId}","href":"/api-reference/templates/delete-template"},{"title":"List template categories","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/templates/categories","href":"/api-reference/templates/list-template-categories"}]},{"group":"Workflows","pages":[{"title":"List workflows","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/workflows","href":"/api-reference/workflows/list-workflows"},{"title":"Create workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/workflows","href":"/api-reference/workflows/create-workflow"},{"title":"Create workflow from template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/workflows/from-template/{templateId}","href":"/api-reference/workflows/create-workflow-from-template"},{"title":"List workflow templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/workflows/templates","href":"/api-reference/workflows/list-workflow-templates"},{"title":"Get workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/workflows/{workflowId}","href":"/api-reference/workflows/get-workflow"},{"title":"Update workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/workflows/{workflowId}","href":"/api-reference/workflows/update-workflow"},{"title":"Delete workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/workflows/{workflowId}","href":"/api-reference/workflows/delete-workflow"},{"title":"Publish workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/workflows/{workflowId}/publish","href":"/api-reference/workflows/publish-workflow"},{"title":"Revert workflow version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/workflows/{workflowId}/revert/{version}","href":"/api-reference/workflows/revert-workflow-version"},{"title":"Save workflow draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/workflows/{workflowId}/save-draft","href":"/api-reference/workflows/save-workflow-draft"},{"title":"Toggle workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/workflows/{workflowId}/toggle","href":"/api-reference/workflows/toggle-workflow"},{"title":"List workflow versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/workflows/{workflowId}/versions","href":"/api-reference/workflows/list-workflow-versions"},{"title":"List all workflow templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/workflows/templates/all","href":"/api-reference/workflows/list-all-workflow-templates"}]},{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /core/accounts/{account_id}/agents","href":"/api-reference/agents/list-agents"},{"title":"Create agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/agents","href":"/api-reference/agents/create-agent"},{"title":"Bulk create agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/agents/bulk_create","href":"/api-reference/agents/bulk-create-agents"},{"title":"Delete agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /core/accounts/{account_id}/agents/{id}","href":"/api-reference/agents/delete-agent"},{"title":"Update agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /core/accounts/{account_id}/agents/{id}","href":"/api-reference/agents/update-agent"}]},{"group":"Conversations","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /core/accounts/{account_id}/conversations","href":"/api-reference/conversations/list-conversations"},{"title":"Create a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations","href":"/api-reference/conversations/create-a-conversation"},{"title":"Filter conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/filter","href":"/api-reference/conversations/filter-conversations"},{"title":"Get conversation meta counts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /core/accounts/{account_id}/conversations/meta","href":"/api-reference/conversations/get-conversation-meta-counts"},{"title":"Search conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /core/accounts/{account_id}/conversations/search","href":"/api-reference/conversations/search-conversations"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /core/accounts/{account_id}/conversations/{conversation_id}","href":"/api-reference/conversations/get-a-conversation"},{"title":"Delete a conversation (moves it to Archived)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /core/accounts/{account_id}/conversations/{conversation_id}","href":"/api-reference/conversations/delete-a-conversation-moves-it-to-archived"},{"title":"Update a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /core/accounts/{account_id}/conversations/{conversation_id}","href":"/api-reference/conversations/update-a-conversation"},{"title":"Restore an archived conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/restore","href":"/api-reference/conversations/restore-an-archived-conversation"},{"title":"Update conversation assignments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/assignments","href":"/api-reference/conversations/update-conversation-assignments"},{"title":"List conversation attachments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /core/accounts/{account_id}/conversations/{conversation_id}/attachments","href":"/api-reference/conversations/list-conversation-attachments"},{"title":"Update custom attributes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/custom_attributes","href":"/api-reference/conversations/update-custom-attributes"},{"title":"List conversation labels","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /core/accounts/{account_id}/conversations/{conversation_id}/labels","href":"/api-reference/conversations/list-conversation-labels"},{"title":"Update conversation labels","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/labels","href":"/api-reference/conversations/update-conversation-labels"},{"title":"Mute a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/mute","href":"/api-reference/conversations/mute-a-conversation"},{"title":"List conversation participants","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /core/accounts/{account_id}/conversations/{conversation_id}/participants","href":"/api-reference/conversations/list-conversation-participants"},{"title":"Update conversation participants","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /core/accounts/{account_id}/conversations/{conversation_id}/participants","href":"/api-reference/conversations/update-conversation-participants"},{"title":"Toggle conversation priority","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/toggle_priority","href":"/api-reference/conversations/toggle-conversation-priority"},{"title":"Toggle conversation status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/toggle_status","href":"/api-reference/conversations/toggle-conversation-status"},{"title":"Toggle typing status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/toggle_typing_status","href":"/api-reference/conversations/toggle-typing-status"},{"title":"Send conversation transcript","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/transcript","href":"/api-reference/conversations/send-conversation-transcript"},{"title":"Unmute a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/unmute","href":"/api-reference/conversations/unmute-a-conversation"},{"title":"Mark conversation as unread","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/unread","href":"/api-reference/conversations/mark-conversation-as-unread"},{"title":"Update last seen","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/update_last_seen","href":"/api-reference/conversations/update-last-seen"}]},{"group":"Messages","pages":[{"title":"List messages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /core/accounts/{account_id}/conversations/{conversation_id}/messages","href":"/api-reference/messages/list-messages"},{"title":"Create a message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/messages","href":"/api-reference/messages/create-a-message"},{"title":"Delete a message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /core/accounts/{account_id}/conversations/{conversation_id}/messages/{id}","href":"/api-reference/messages/delete-a-message"},{"title":"Retry a message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/messages/{id}/retry","href":"/api-reference/messages/retry-a-message"},{"title":"Translate a message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/messages/{id}/translate","href":"/api-reference/messages/translate-a-message"}]},{"group":"Inboxes","pages":[{"title":"List inboxes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /core/accounts/{account_id}/inboxes","href":"/api-reference/inboxes/list-inboxes"},{"title":"Create inbox","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/inboxes","href":"/api-reference/inboxes/create-inbox"},{"title":"Show inbox","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /core/accounts/{account_id}/inboxes/{id}","href":"/api-reference/inboxes/show-inbox"},{"title":"Delete inbox","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /core/accounts/{account_id}/inboxes/{id}","href":"/api-reference/inboxes/delete-inbox"},{"title":"Update inbox","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /core/accounts/{account_id}/inboxes/{id}","href":"/api-reference/inboxes/update-inbox"}]},{"group":"Teams","pages":[{"title":"List teams","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /core/accounts/{account_id}/teams","href":"/api-reference/teams/list-teams"},{"title":"Create team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/teams","href":"/api-reference/teams/create-team"},{"title":"Show team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /core/accounts/{account_id}/teams/{id}","href":"/api-reference/teams/show-team"},{"title":"Delete team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /core/accounts/{account_id}/teams/{id}","href":"/api-reference/teams/delete-team"},{"title":"Update team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /core/accounts/{account_id}/teams/{id}","href":"/api-reference/teams/update-team"}]},{"group":"Sales CRM","pages":[{"title":"List Sales Leads","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/leads","href":"/api-reference/sales-crm/list-sales-leads"},{"title":"Create a Sales Lead","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/leads","href":"/api-reference/sales-crm/create-a-sales-lead"},{"title":"Get a Sales Lead","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/leads/{leadId}","href":"/api-reference/sales-crm/get-a-sales-lead"},{"title":"Update a Sales Lead","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/leads/{leadId}","href":"/api-reference/sales-crm/update-a-sales-lead"},{"title":"Update Lead qualification status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/leads/{leadId}/status","href":"/api-reference/sales-crm/update-lead-qualification-status"},{"title":"Convert a qualified Lead","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/leads/{leadId}/convert","href":"/api-reference/sales-crm/convert-a-qualified-lead"},{"title":"Get Lead history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/leads/{leadId}/history","href":"/api-reference/sales-crm/get-lead-history"},{"title":"List Sales products","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/products","href":"/api-reference/sales-crm/list-sales-products"},{"title":"Create a Sales product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/products","href":"/api-reference/sales-crm/create-a-sales-product"},{"title":"Archive or restore a Sales product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/accounts/{accountId}/sales/products/{productId}/active","href":"/api-reference/sales-crm/archive-or-restore-a-sales-product"},{"title":"List Sales price books","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/price-books","href":"/api-reference/sales-crm/list-sales-price-books"},{"title":"Create a Sales price book","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/price-books","href":"/api-reference/sales-crm/create-a-sales-price-book"},{"title":"List price-book entries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/price-books/{priceBookId}/entries","href":"/api-reference/sales-crm/list-price-book-entries"},{"title":"Add a price-book entry","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/price-books/{priceBookId}/entries","href":"/api-reference/sales-crm/add-a-price-book-entry"},{"title":"List Sales quotes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/quotes","href":"/api-reference/sales-crm/list-sales-quotes"},{"title":"Create a Sales quote","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/quotes","href":"/api-reference/sales-crm/create-a-sales-quote"},{"title":"List Deals","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/deals","href":"/api-reference/sales-crm/list-deals"},{"title":"Create a Deal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/deals","href":"/api-reference/sales-crm/create-a-deal"},{"title":"Move a Deal stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/deals/{dealId}/move","href":"/api-reference/sales-crm/move-a-deal-stage"},{"title":"Bulk assign Sales Leads","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/leads/bulk-assign","href":"/api-reference/sales-crm/bulk-assign-sales-leads"},{"title":"Find the Lead linked to a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/leads/by-conversation/{conversationId}","href":"/api-reference/sales-crm/find-the-lead-linked-to-a-conversation"},{"title":"Export Sales Leads","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/leads/export","href":"/api-reference/sales-crm/export-sales-leads"},{"title":"Assign a Lead","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/leads/{leadId}/assign","href":"/api-reference/sales-crm/assign-a-lead"},{"title":"Review Lead duplicate candidates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/leads/{leadId}/duplicates","href":"/api-reference/sales-crm/review-lead-duplicate-candidates"},{"title":"Upload a Lead file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/leads/{leadId}/files","href":"/api-reference/sales-crm/upload-a-lead-file"},{"title":"Download a Lead file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/leads/{leadId}/files/{fileId}","href":"/api-reference/sales-crm/download-a-lead-file"},{"title":"Delete a Lead file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/leads/{leadId}/files/{fileId}","href":"/api-reference/sales-crm/delete-a-lead-file"},{"title":"Move a Lead on the qualification board","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/leads/{leadId}/move","href":"/api-reference/sales-crm/move-a-lead-on-the-qualification-board"},{"title":"Add a Lead note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/leads/{leadId}/notes","href":"/api-reference/sales-crm/add-a-lead-note"},{"title":"List native Companies","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/companies","href":"/api-reference/sales-crm/list-native-companies"},{"title":"Create a Company","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/companies","href":"/api-reference/sales-crm/create-a-company"},{"title":"Get a Company record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/companies/{companyId}","href":"/api-reference/sales-crm/get-a-company-record"},{"title":"Update a Company record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/sales/companies/{companyId}","href":"/api-reference/sales-crm/update-a-company-record"},{"title":"Archive or restore a Company","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/accounts/{accountId}/sales/companies/{companyId}/archive","href":"/api-reference/sales-crm/archive-or-restore-a-company"},{"title":"Add a Company contact role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/companies/{companyId}/contact-roles","href":"/api-reference/sales-crm/add-a-company-contact-role"},{"title":"Remove a Company contact role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/sales/companies/{companyId}/contact-roles/{roleId}","href":"/api-reference/sales-crm/remove-a-company-contact-role"},{"title":"Upload a Company file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/companies/{companyId}/files","href":"/api-reference/sales-crm/upload-a-company-file"},{"title":"Download a Company file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/companies/{companyId}/files/{fileId}","href":"/api-reference/sales-crm/download-a-company-file"},{"title":"Delete a Company file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/sales/companies/{companyId}/files/{fileId}","href":"/api-reference/sales-crm/delete-a-company-file"},{"title":"Add a Company note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/companies/{companyId}/notes","href":"/api-reference/sales-crm/add-a-company-note"},{"title":"Get the full Deal record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/deals/{dealId}","href":"/api-reference/sales-crm/get-the-full-deal-record"},{"title":"Update the full Deal record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/sales/deals/{dealId}","href":"/api-reference/sales-crm/update-the-full-deal-record"},{"title":"Add a Deal contact role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/deals/{dealId}/contact-roles","href":"/api-reference/sales-crm/add-a-deal-contact-role"},{"title":"Remove a Deal contact role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/sales/deals/{dealId}/contact-roles/{roleId}","href":"/api-reference/sales-crm/remove-a-deal-contact-role"},{"title":"Upload a Deal file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/deals/{dealId}/files","href":"/api-reference/sales-crm/upload-a-deal-file"},{"title":"Download a Deal file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/deals/{dealId}/files/{fileId}","href":"/api-reference/sales-crm/download-a-deal-file"},{"title":"Delete a Deal file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/sales/deals/{dealId}/files/{fileId}","href":"/api-reference/sales-crm/delete-a-deal-file"},{"title":"Add a product to a Deal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/deals/{dealId}/line-items","href":"/api-reference/sales-crm/add-a-product-to-a-deal"},{"title":"Remove a Deal line item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/sales/deals/{dealId}/line-items/{lineItemId}","href":"/api-reference/sales-crm/remove-a-deal-line-item"},{"title":"Add a Deal note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/deals/{dealId}/notes","href":"/api-reference/sales-crm/add-a-deal-note"},{"title":"Get Sales forecast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/forecast","href":"/api-reference/sales-crm/get-sales-forecast"},{"title":"Save a Sales quota","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/sales/forecast/quotas","href":"/api-reference/sales-crm/save-a-sales-quota"},{"title":"Capture a Sales forecast snapshot","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/forecast/snapshots","href":"/api-reference/sales-crm/capture-a-sales-forecast-snapshot"},{"title":"Get Sales overview","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/overview","href":"/api-reference/sales-crm/get-sales-overview"},{"title":"Get a Sales price book","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/price-books/{priceBookId}","href":"/api-reference/sales-crm/get-a-sales-price-book"},{"title":"Update a Sales price book","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/sales/price-books/{priceBookId}","href":"/api-reference/sales-crm/update-a-sales-price-book"},{"title":"Clone a Sales price book","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/price-books/{priceBookId}/clone","href":"/api-reference/sales-crm/clone-a-sales-price-book"},{"title":"Update a price-book entry","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/sales/price-books/{priceBookId}/entries/{entryId}","href":"/api-reference/sales-crm/update-a-price-book-entry"},{"title":"Delete a price-book entry","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/sales/price-books/{priceBookId}/entries/{entryId}","href":"/api-reference/sales-crm/delete-a-price-book-entry"},{"title":"Get a Sales product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/products/{productId}","href":"/api-reference/sales-crm/get-a-sales-product"},{"title":"Update a Sales product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/sales/products/{productId}","href":"/api-reference/sales-crm/update-a-sales-product"},{"title":"Get a Sales quote","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/quotes/{quoteId}","href":"/api-reference/sales-crm/get-a-sales-quote"},{"title":"Edit an unshared Sales quote draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/sales/quotes/{quoteId}","href":"/api-reference/sales-crm/edit-an-unshared-sales-quote-draft"},{"title":"Decide a quote approval","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/accounts/{accountId}/sales/quotes/{quoteId}/approval","href":"/api-reference/sales-crm/decide-a-quote-approval"},{"title":"Update quote lifecycle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/accounts/{accountId}/sales/quotes/{quoteId}/lifecycle","href":"/api-reference/sales-crm/update-quote-lifecycle"},{"title":"Create a payment request record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/quotes/{quoteId}/payment-requests","href":"/api-reference/sales-crm/create-a-payment-request-record"},{"title":"View or download a quotation PDF","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/quotes/{quoteId}/pdf","href":"/api-reference/sales-crm/view-or-download-a-quotation-pdf"},{"title":"Upload or replace a quotation PDF","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/quotes/{quoteId}/pdf","href":"/api-reference/sales-crm/upload-or-replace-a-quotation-pdf"},{"title":"Remove a quotation PDF","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/sales/quotes/{quoteId}/pdf","href":"/api-reference/sales-crm/remove-a-quotation-pdf"},{"title":"Create a quote revision","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/quotes/{quoteId}/revisions","href":"/api-reference/sales-crm/create-a-quote-revision"},{"title":"Get Sales reports","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/reports","href":"/api-reference/sales-crm/get-sales-reports"},{"title":"List saved Sales views","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/saved-views","href":"/api-reference/sales-crm/list-saved-sales-views"},{"title":"Create a saved Sales view","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/saved-views","href":"/api-reference/sales-crm/create-a-saved-sales-view"},{"title":"Delete a saved Sales view","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/sales/saved-views/{viewId}","href":"/api-reference/sales-crm/delete-a-saved-sales-view"},{"title":"Get Sales settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/settings","href":"/api-reference/sales-crm/get-sales-settings"},{"title":"Save Sales settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/sales/settings","href":"/api-reference/sales-crm/save-sales-settings"},{"title":"List unified Sales tasks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/tasks","href":"/api-reference/sales-crm/list-unified-sales-tasks"},{"title":"Create a Sales task","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/tasks","href":"/api-reference/sales-crm/create-a-sales-task"},{"title":"Update a Sales task","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/sales/tasks/{taskId}","href":"/api-reference/sales-crm/update-a-sales-task"},{"title":"Delete a Sales task","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/sales/tasks/{taskId}","href":"/api-reference/sales-crm/delete-a-sales-task"},{"title":"Change a Sales task status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/accounts/{accountId}/sales/tasks/{taskId}/status","href":"/api-reference/sales-crm/change-a-sales-task-status"},{"title":"Create or rotate a private quote link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/quotes/{quoteId}/share-link","href":"/api-reference/sales-crm/create-or-rotate-a-private-quote-link"},{"title":"Decide a deal line-item discount approval","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/accounts/{accountId}/sales/deals/{dealId}/line-items/{lineItemId}/approval","href":"/api-reference/sales-crm/decide-a-deal-line-item-discount-approval"},{"title":"Get a Sales pipeline definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/pipelines/{pipelineId}/definition","href":"/api-reference/sales-crm/get-a-sales-pipeline-definition"},{"title":"Save a Sales pipeline definition atomically","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/sales/pipelines/{pipelineId}/definition","href":"/api-reference/sales-crm/save-a-sales-pipeline-definition-atomically"},{"title":"Search products available for a price book","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/price-books/{priceBookId}/candidates","href":"/api-reference/sales-crm/search-products-available-for-a-price-book"},{"title":"Add price-book entries atomically","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/price-books/{priceBookId}/entries/batch","href":"/api-reference/sales-crm/add-price-book-entries-atomically"},{"title":"List quote versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/quotes/{quoteId}/versions","href":"/api-reference/sales-crm/list-quote-versions"},{"title":"Get Sales working hours","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/working-hours/{inboxId}","href":"/api-reference/sales-crm/get-sales-working-hours"},{"title":"Save Sales working hours","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/sales/working-hours/{inboxId}","href":"/api-reference/sales-crm/save-sales-working-hours"}]}]}]}]},{"language":"ar","tabs":[{"tab":"الدليل","pages":[{"title":"الدليل","href":"/ar/introduction"}]},{"tab":"مرجع API","groups":[{"group":"نظرة عامة","pages":[{"title":"مرجع API","href":"/ar/api-reference/overview"}]},{"group":"نقاط النهاية","pages":[{"group":"AI Agents","pages":[{"title":"List AI agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/ai-agents","href":"/api-reference/ai-agents/list-ai-agents"},{"title":"Create AI agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents","href":"/api-reference/ai-agents/create-ai-agent"},{"title":"Create AI agent from template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/from-template","href":"/api-reference/ai-agents/create-ai-agent-from-template"},{"title":"List agent templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/ai-agents/templates","href":"/api-reference/ai-agents/list-agent-templates"},{"title":"Preview TTS voice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/tts-preview","href":"/api-reference/ai-agents/preview-tts-voice"},{"title":"List TTS voices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/ai-agents/tts-voices","href":"/api-reference/ai-agents/list-tts-voices"},{"title":"Get AI agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/ai-agents/{agentId}","href":"/api-reference/ai-agents/get-ai-agent"},{"title":"Update AI agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/ai-agents/{agentId}","href":"/api-reference/ai-agents/update-ai-agent"},{"title":"Delete AI agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/ai-agents/{agentId}","href":"/api-reference/ai-agents/delete-ai-agent"},{"title":"Publish AI agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/{agentId}/publish","href":"/api-reference/ai-agents/publish-ai-agent"},{"title":"Get AI agent stats","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/ai-agents/{agentId}/stats","href":"/api-reference/ai-agents/get-ai-agent-stats"},{"title":"Test AI agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/{agentId}/test","href":"/api-reference/ai-agents/test-ai-agent"},{"title":"Clear test history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/ai-agents/{agentId}/test","href":"/api-reference/ai-agents/clear-test-history"},{"title":"Toggle AI agent active state","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/{agentId}/toggle","href":"/api-reference/ai-agents/toggle-ai-agent-active-state"},{"title":"List agent versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/ai-agents/{agentId}/versions","href":"/api-reference/ai-agents/list-agent-versions"},{"title":"Rollback agent version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/{agentId}/versions/{versionId}/rollback","href":"/api-reference/ai-agents/rollback-agent-version"},{"title":"Get AI analytics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/ai-analytics","href":"/api-reference/ai-agents/get-ai-analytics"},{"title":"Get conversation handoff status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/conversations/{convID}/handoff","href":"/api-reference/ai-agents/get-conversation-handoff-status"},{"title":"Set conversation handoff status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/conversations/{convID}/handoff","href":"/api-reference/ai-agents/set-conversation-handoff-status"},{"title":"List inboxes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/inboxes","href":"/api-reference/ai-agents/list-inboxes"}]},{"group":"Forms","pages":[{"title":"Generate a validated form preview through Agent AI","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/{agentId}/forms/generate","href":"/api-reference/forms/generate-a-validated-form-preview-through-agent-ai"},{"title":"Get monthly AI form draft allowance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/ai-agents/{agentId}/forms/generation-usage","href":"/api-reference/forms/get-monthly-ai-form-draft-allowance"},{"title":"List workspace forms","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/forms","href":"/api-reference/forms/list-workspace-forms"},{"title":"Create a draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/forms","href":"/api-reference/forms/create-a-draft"},{"title":"Generate a validated form preview in Forms","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/forms/ai/generate","href":"/api-reference/forms/generate-a-validated-form-preview-in-forms"},{"title":"Get monthly AI form draft allowance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/forms/ai/generation-usage","href":"/api-reference/forms/get-monthly-ai-form-draft-allowance-1"},{"title":"Read a form draft and metadata","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/forms/{formId}","href":"/api-reference/forms/read-a-form-draft-and-metadata"},{"title":"Save a draft with optimistic version check","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/accounts/{accountId}/forms/{formId}","href":"/api-reference/forms/save-a-draft-with-optimistic-version-check"},{"title":"Archive reversibly","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/forms/{formId}/archive","href":"/api-reference/forms/archive-reversibly"},{"title":"Upload native design media","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/forms/{formId}/assets","href":"/api-reference/forms/upload-native-design-media"},{"title":"Read a native form asset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/forms/{formId}/assets/{assetId}","href":"/api-reference/forms/read-a-native-form-asset"},{"title":"Close a published form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/forms/{formId}/close","href":"/api-reference/forms/close-a-published-form"},{"title":"Track private invitation delivery and completion","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/forms/{formId}/invitations","href":"/api-reference/forms/track-private-invitation-delivery-and-completion"},{"title":"Create an identity-bound recipient invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/forms/{formId}/invitations","href":"/api-reference/forms/create-an-identity-bound-recipient-invitation"},{"title":"List administrative invitation records","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/forms/{formId}/invitations/manage","href":"/api-reference/forms/list-administrative-invitation-records"},{"title":"Revoke an active invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/forms/{formId}/invitations/{invitationId}/revoke","href":"/api-reference/forms/revoke-an-active-invitation"},{"title":"Publish an immutable form version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/forms/{formId}/publish","href":"/api-reference/forms/publish-an-immutable-form-version"},{"title":"Form performance and question summaries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/forms/{formId}/reports","href":"/api-reference/forms/form-performance-and-question-summaries"},{"title":"List partial and completed responses","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/forms/{formId}/responses","href":"/api-reference/forms/list-partial-and-completed-responses"},{"title":"Export filtered response CSV","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/forms/{formId}/responses/export.csv","href":"/api-reference/forms/export-filtered-response-csv"},{"title":"Restore to closed if previously published, otherwise draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/forms/{formId}/restore","href":"/api-reference/forms/restore-to-closed-if-previously-published-otherwise-draft"},{"title":"Rotate opaque public code. Earlier public and recipient URLs stop resolving","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/forms/{formId}/rotate-link","href":"/api-reference/forms/rotate-opaque-public-code-earlier-public-and-recipient-urls-stop-resolving"},{"title":"List published immutable versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/forms/{formId}/versions","href":"/api-reference/forms/list-published-immutable-versions"},{"title":"Read a native form asset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/form-assets/{assetId}","href":"/api-reference/forms/read-a-native-form-asset-1"},{"title":"Open a published form and obtain a signed session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/forms/{publicCode}","href":"/api-reference/forms/open-a-published-form-and-obtain-a-signed-session"},{"title":"Get a bounded respondent AI answer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/forms/{publicCode}/ai/respond","href":"/api-reference/forms/get-a-bounded-respondent-ai-answer"},{"title":"Upload a signed respondent attachment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/forms/{publicCode}/assets","href":"/api-reference/forms/upload-a-signed-respondent-attachment"},{"title":"Record a respondent funnel event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/forms/{publicCode}/events","href":"/api-reference/forms/record-a-respondent-funnel-event"},{"title":"Suggest saved CDP answers with explicit opt-in","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/forms/{publicCode}/prefill","href":"/api-reference/forms/suggest-saved-cdp-answers-with-explicit-opt-in"},{"title":"Save partial or completed answers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/forms/{publicCode}/responses","href":"/api-reference/forms/save-partial-or-completed-answers"},{"title":"Book a native appointment for this question","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/forms/{publicCode}/schedule/book","href":"/api-reference/forms/book-a-native-appointment-for-this-question"},{"title":"Get native appointment availability","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/forms/{publicCode}/schedule/slots","href":"/api-reference/forms/get-native-appointment-availability"}]},{"group":"Knowledge","pages":[{"title":"Add knowledge text","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/{agentId}/knowledge/text","href":"/api-reference/knowledge/add-knowledge-text"},{"title":"Upload knowledge file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/{agentId}/knowledge/upload","href":"/api-reference/knowledge/upload-knowledge-file"},{"title":"Add knowledge URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/{agentId}/knowledge/url","href":"/api-reference/knowledge/add-knowledge-url"},{"title":"Get knowledge source","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/ai-agents/{agentId}/knowledge/{sourceId}","href":"/api-reference/knowledge/get-knowledge-source"},{"title":"Update knowledge source","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/ai-agents/{agentId}/knowledge/{sourceId}","href":"/api-reference/knowledge/update-knowledge-source"},{"title":"Delete knowledge source","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/ai-agents/{agentId}/knowledge/{sourceId}","href":"/api-reference/knowledge/delete-knowledge-source"},{"title":"Upload knowledge image","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/{agentId}/knowledge/{sourceId}/images","href":"/api-reference/knowledge/upload-knowledge-image"},{"title":"Delete knowledge image","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/ai-agents/{agentId}/knowledge/{sourceId}/images/{index}","href":"/api-reference/knowledge/delete-knowledge-image"},{"title":"Reindex knowledge source","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/{agentId}/knowledge/{sourceId}/reindex","href":"/api-reference/knowledge/reindex-knowledge-source"},{"title":"Get RAG indexing status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/ai-agents/{agentId}/rag-status","href":"/api-reference/knowledge/get-rag-indexing-status"},{"title":"Reindex all knowledge sources","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/{agentId}/reindex-all","href":"/api-reference/knowledge/reindex-all-knowledge-sources"},{"title":"Search knowledge base","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/ai-agents/{agentId}/search-knowledge","href":"/api-reference/knowledge/search-knowledge-base"},{"title":"List all knowledge sources","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/knowledge-sources","href":"/api-reference/knowledge/list-all-knowledge-sources"},{"title":"Create knowledge source (standalone)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/knowledge-sources","href":"/api-reference/knowledge/create-knowledge-source-standalone"},{"title":"Get knowledge source (standalone)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/knowledge-sources/{sourceId}","href":"/api-reference/knowledge/get-knowledge-source-standalone"},{"title":"Delete knowledge source (standalone)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/knowledge-sources/{sourceId}","href":"/api-reference/knowledge/delete-knowledge-source-standalone"},{"title":"Update knowledge source (standalone)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/accounts/{accountId}/knowledge-sources/{sourceId}","href":"/api-reference/knowledge/update-knowledge-source-standalone"},{"title":"Reindex knowledge source (standalone)","description":"Re-indexes a knowledge source by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/knowledge-sources/{sourceId}/reprocess","href":"/api-reference/knowledge/reindex-knowledge-source-standalone"}]},{"group":"Appointments","pages":[{"title":"List appointments and catalog","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments","href":"/api-reference/appointments/list-appointments-and-catalog"},{"title":"Create or safely replay an appointment","description":"Requires appointments:write. Select the appointment type by service_id or exact service_name; select a resource by resource_id/resource_name or omit it to use an eligible available resource. Supply starts_at in RFC3339 or local date plus time in the account timezone. The configured service duration determines ends_at, so ends_at is optional. The requested time is revalidated against the same rules returned by the slot endpoint. Supplying contact_id also requires contacts:read; supplying deal_id also requires deals:write and UUID selectors. API-key callers must provide external_id; retrying the identical request returns the existing appointment without creating a duplicate. A REST key with appointments:sync on an account approved for a scheduling system connection is treated like PUT /appointments/external/{externalId}: the booking is stored as the system has it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/appointments","href":"/api-reference/appointments/create-or-safely-replay-an-appointment"},{"title":"List appointment availability","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/availability","href":"/api-reference/appointments/list-appointment-availability"},{"title":"Create availability exception","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/appointments/availability/exceptions","href":"/api-reference/appointments/create-availability-exception"},{"title":"Delete availability exception","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/appointments/availability/exceptions/{exceptionId}","href":"/api-reference/appointments/delete-availability-exception"},{"title":"Set weekly availability rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/appointments/availability/rules","href":"/api-reference/appointments/set-weekly-availability-rule"},{"title":"Replace weekly availability rules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/appointments/availability/rules/bulk","href":"/api-reference/appointments/replace-weekly-availability-rules"},{"title":"Get appointment catalog","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/catalog","href":"/api-reference/appointments/get-appointment-catalog"},{"title":"Get appointment by external ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/external/{externalId}","href":"/api-reference/appointments/get-appointment-by-external-id"},{"title":"Sync one appointment from a scheduling system","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/appointments/external/{externalId}","href":"/api-reference/appointments/sync-one-appointment-from-a-scheduling-system"},{"title":"Cancel a synced appointment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/appointments/external/{externalId}","href":"/api-reference/appointments/cancel-a-synced-appointment"},{"title":"Import or safely replay a historical appointment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/appointments/history","href":"/api-reference/appointments/import-or-safely-replay-a-historical-appointment"},{"title":"Get appointment reports","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/reports","href":"/api-reference/appointments/get-appointment-reports"},{"title":"List appointment resources","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/resources","href":"/api-reference/appointments/list-appointment-resources"},{"title":"Create appointment resource","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/appointments/resources","href":"/api-reference/appointments/create-appointment-resource"},{"title":"Get appointment resource","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/resources/{resourceId}","href":"/api-reference/appointments/get-appointment-resource"},{"title":"Update appointment resource","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/appointments/resources/{resourceId}","href":"/api-reference/appointments/update-appointment-resource"},{"title":"Archive appointment resource","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/appointments/resources/{resourceId}","href":"/api-reference/appointments/archive-appointment-resource"},{"title":"Restore appointment resource","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/appointments/resources/{resourceId}/restore","href":"/api-reference/appointments/restore-appointment-resource"},{"title":"List appointment services","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/services","href":"/api-reference/appointments/list-appointment-services"},{"title":"Create appointment service","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/appointments/services","href":"/api-reference/appointments/create-appointment-service"},{"title":"Get appointment service","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/services/{serviceId}","href":"/api-reference/appointments/get-appointment-service"},{"title":"Update appointment service","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/appointments/services/{serviceId}","href":"/api-reference/appointments/update-appointment-service"},{"title":"Archive appointment service","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/appointments/services/{serviceId}","href":"/api-reference/appointments/archive-appointment-service"},{"title":"Assign resources to appointment service","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/appointments/services/{serviceId}/resources","href":"/api-reference/appointments/assign-resources-to-appointment-service"},{"title":"Restore appointment service","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/appointments/services/{serviceId}/restore","href":"/api-reference/appointments/restore-appointment-service"},{"title":"Get appointment settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/settings","href":"/api-reference/appointments/get-appointment-settings"},{"title":"Update appointment settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/appointments/settings","href":"/api-reference/appointments/update-appointment-settings"},{"title":"List available appointment slots","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/slots","href":"/api-reference/appointments/list-available-appointment-slots"},{"title":"Get appointment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/{id}","href":"/api-reference/appointments/get-appointment"},{"title":"Update appointment details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/accounts/{accountId}/appointments/{id}","href":"/api-reference/appointments/update-appointment-details"},{"title":"Reschedule appointment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/accounts/{accountId}/appointments/{id}/schedule","href":"/api-reference/appointments/reschedule-appointment"},{"title":"Update appointment status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/accounts/{accountId}/appointments/{id}/status","href":"/api-reference/appointments/update-appointment-status"},{"title":"List synced appointments for reconciliation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/sync","href":"/api-reference/appointments/list-synced-appointments-for-reconciliation"},{"title":"Sync a batch of appointments from a scheduling system","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/appointments/sync","href":"/api-reference/appointments/sync-a-batch-of-appointments-from-a-scheduling-system"},{"title":"Scheduling system connection status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/sync/status","href":"/api-reference/appointments/scheduling-system-connection-status"},{"title":"Sync a FHIR R4 batch Bundle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/fhir/R4","href":"/api-reference/appointments/sync-a-fhir-r4-batch-bundle"},{"title":"Read a synced FHIR R4 Appointment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/fhir/R4/Appointment/{fhirId}","href":"/api-reference/appointments/read-a-synced-fhir-r4-appointment"},{"title":"Sync a FHIR R4 Appointment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/fhir/R4/Appointment/{fhirId}","href":"/api-reference/appointments/sync-a-fhir-r4-appointment"},{"title":"Delete a synced FHIR R4 Appointment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/fhir/R4/Appointment/{fhirId}","href":"/api-reference/appointments/delete-a-synced-fhir-r4-appointment"},{"title":"FHIR R4 capability statement for scheduling systems","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/fhir/R4/metadata","href":"/api-reference/appointments/fhir-r4-capability-statement-for-scheduling-systems"}]},{"group":"Appointment reminders","pages":[{"title":"List reminder delivery receipts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/reminder-deliveries","href":"/api-reference/appointment-reminders/list-reminder-delivery-receipts"},{"title":"List appointment reminder rules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/reminders","href":"/api-reference/appointment-reminders/list-appointment-reminder-rules"},{"title":"Create an appointment reminder with an optional published form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/appointments/reminders","href":"/api-reference/appointment-reminders/create-an-appointment-reminder-with-an-optional-published-form"},{"title":"Update a reminder and its optional form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/appointments/reminders/{reminderId}","href":"/api-reference/appointment-reminders/update-a-reminder-and-its-optional-form"},{"title":"Disable a reminder rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/appointments/reminders/{reminderId}","href":"/api-reference/appointment-reminders/disable-a-reminder-rule"}]},{"group":"Broadcasts","pages":[{"title":"List broadcasts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/broadcasts","href":"/api-reference/broadcasts/list-broadcasts"},{"title":"Create broadcast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/broadcasts","href":"/api-reference/broadcasts/create-broadcast"},{"title":"Broadcast reports","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/broadcasts/reports","href":"/api-reference/broadcasts/broadcast-reports"},{"title":"Get broadcast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/broadcasts/{broadcastId}","href":"/api-reference/broadcasts/get-broadcast"},{"title":"Update broadcast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/broadcasts/{broadcastId}","href":"/api-reference/broadcasts/update-broadcast"},{"title":"Delete broadcast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/broadcasts/{broadcastId}","href":"/api-reference/broadcasts/delete-broadcast"},{"title":"Cancel broadcast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/broadcasts/{broadcastId}/cancel","href":"/api-reference/broadcasts/cancel-broadcast"},{"title":"List broadcast recipients","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/broadcasts/{broadcastId}/recipients","href":"/api-reference/broadcasts/list-broadcast-recipients"},{"title":"Send broadcast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/broadcasts/{broadcastId}/send","href":"/api-reference/broadcasts/send-broadcast"},{"title":"Upload CSV recipients","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/broadcasts/{broadcastId}/upload-csv","href":"/api-reference/broadcasts/upload-csv-recipients"}]},{"group":"Customer CDP","pages":[{"title":"Get Customer CDP access","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/access","href":"/api-reference/customer-cdp/get-customer-cdp-access"},{"title":"List audiences","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/audiences","href":"/api-reference/customer-cdp/list-audiences"},{"title":"Create an audience","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/audiences","href":"/api-reference/customer-cdp/create-an-audience"},{"title":"Preview audience customers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/audiences/preview","href":"/api-reference/customer-cdp/preview-audience-customers"},{"title":"Update an audience","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/cdp/audiences/{audienceId}","href":"/api-reference/customer-cdp/update-an-audience"},{"title":"Delete an audience","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/cdp/audiences/{audienceId}","href":"/api-reference/customer-cdp/delete-an-audience"},{"title":"List saved audience customers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/audiences/{audienceId}/customers","href":"/api-reference/customer-cdp/list-saved-audience-customers"},{"title":"List advanced customer records","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/customers","href":"/api-reference/customer-cdp/list-advanced-customer-records"},{"title":"Get customer activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/customers/{contactId}/activity","href":"/api-reference/customer-cdp/get-customer-activity"},{"title":"List customer journeys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/journeys","href":"/api-reference/customer-cdp/list-customer-journeys"},{"title":"Create a customer journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/journeys","href":"/api-reference/customer-cdp/create-a-customer-journey"},{"title":"Get journey options","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/journeys/options","href":"/api-reference/customer-cdp/get-journey-options"},{"title":"Preview a customer journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/journeys/preview","href":"/api-reference/customer-cdp/preview-a-customer-journey"},{"title":"Get a customer journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/journeys/{workflowId}","href":"/api-reference/customer-cdp/get-a-customer-journey"},{"title":"Update a customer journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/cdp/journeys/{workflowId}","href":"/api-reference/customer-cdp/update-a-customer-journey"},{"title":"Publish a customer journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/journeys/{workflowId}/publish","href":"/api-reference/customer-cdp/publish-a-customer-journey"},{"title":"List journey runs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/journeys/{workflowId}/runs","href":"/api-reference/customer-cdp/list-journey-runs"},{"title":"Cancel a journey run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/journeys/{workflowId}/runs/{runId}/cancel","href":"/api-reference/customer-cdp/cancel-a-journey-run"},{"title":"Review an uncertain journey delivery","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/journeys/{workflowId}/runs/{runId}/review","href":"/api-reference/customer-cdp/review-an-uncertain-journey-delivery"},{"title":"List membership-capable inboxes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/membership/inboxes","href":"/api-reference/customer-cdp/list-membership-capable-inboxes"},{"title":"List memberships","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/membership/members","href":"/api-reference/customer-cdp/list-memberships"},{"title":"Get a membership","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/membership/members/{membershipId}","href":"/api-reference/customer-cdp/get-a-membership"},{"title":"Apply a membership action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/membership/members/{membershipId}/activity","href":"/api-reference/customer-cdp/apply-a-membership-action"},{"title":"Award membership points from an integration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/membership/members/{membershipId}/events","href":"/api-reference/customer-cdp/award-membership-points-from-an-integration"},{"title":"Create a verified member link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/membership/members/{membershipId}/member-link","href":"/api-reference/customer-cdp/create-a-verified-member-link"},{"title":"Fulfill a membership benefit receipt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/membership/members/{membershipId}/receipts/{receiptId}/fulfill","href":"/api-reference/customer-cdp/fulfill-a-membership-benefit-receipt"},{"title":"List membership programs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/membership/programs","href":"/api-reference/customer-cdp/list-membership-programs"},{"title":"Create a membership program","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/membership/programs","href":"/api-reference/customer-cdp/create-a-membership-program"},{"title":"Get a membership program","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/membership/programs/{programId}","href":"/api-reference/customer-cdp/get-a-membership-program"},{"title":"Update a membership program","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/cdp/membership/programs/{programId}","href":"/api-reference/customer-cdp/update-a-membership-program"},{"title":"Get membership program activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/membership/programs/{programId}/activity","href":"/api-reference/customer-cdp/get-membership-program-activity"},{"title":"Create a verified enrollment invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/membership/programs/{programId}/invites","href":"/api-reference/customer-cdp/create-a-verified-enrollment-invitation"},{"title":"List program members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/membership/programs/{programId}/members","href":"/api-reference/customer-cdp/list-program-members"},{"title":"Enroll a contact in a program","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/cdp/membership/programs/{programId}/members","href":"/api-reference/customer-cdp/enroll-a-contact-in-a-program"},{"title":"Check membership program readiness","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/membership/programs/{programId}/readiness","href":"/api-reference/customer-cdp/check-membership-program-readiness"},{"title":"Get CDP preferences","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/preferences","href":"/api-reference/customer-cdp/get-cdp-preferences"},{"title":"Update CDP preferences","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/cdp/preferences","href":"/api-reference/customer-cdp/update-cdp-preferences"},{"title":"List or search contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/contacts","href":"/api-reference/customer-cdp/list-or-search-contacts"},{"title":"Create contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/contacts","href":"/api-reference/customer-cdp/create-contact"},{"title":"Merge contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/contacts/merge","href":"/api-reference/customer-cdp/merge-contacts"},{"title":"Search contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/contacts/search","href":"/api-reference/customer-cdp/search-contacts"},{"title":"Get contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/contacts/{contactId}","href":"/api-reference/customer-cdp/get-contact"},{"title":"Update contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/accounts/{accountId}/contacts/{contactId}","href":"/api-reference/customer-cdp/update-contact"},{"title":"Record contact consent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/contacts/{contactId}/consent","href":"/api-reference/customer-cdp/record-contact-consent"},{"title":"Get contact CDP profile","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/contacts/{contactId}/profile","href":"/api-reference/customer-cdp/get-contact-cdp-profile"},{"title":"List contact CDP timeline","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/contacts/{contactId}/timeline","href":"/api-reference/customer-cdp/list-contact-cdp-timeline"}]},{"group":"Chat Menus","pages":[{"title":"List chat menus","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/chat-menus","href":"/api-reference/chat-menus/list-chat-menus"},{"title":"Create chat menu","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/chat-menus","href":"/api-reference/chat-menus/create-chat-menu"},{"title":"Get chat menu","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/chat-menus/{menuId}","href":"/api-reference/chat-menus/get-chat-menu"},{"title":"Update chat menu","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/chat-menus/{menuId}","href":"/api-reference/chat-menus/update-chat-menu"},{"title":"Delete chat menu","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/chat-menus/{menuId}","href":"/api-reference/chat-menus/delete-chat-menu"},{"title":"Duplicate chat menu","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/chat-menus/{menuId}/duplicate","href":"/api-reference/chat-menus/duplicate-chat-menu"},{"title":"Toggle chat menu","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/chat-menus/{menuId}/toggle","href":"/api-reference/chat-menus/toggle-chat-menu"}]},{"group":"Templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/templates","href":"/api-reference/templates/list-templates"},{"title":"Create template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/templates","href":"/api-reference/templates/create-template"},{"title":"AI-generate template content","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/templates/ai-generate","href":"/api-reference/templates/ai-generate-template-content"},{"title":"Template analytics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/templates/analytics/{templateId}","href":"/api-reference/templates/template-analytics"},{"title":"List WhatsApp inboxes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/templates/inboxes","href":"/api-reference/templates/list-whatsapp-inboxes"},{"title":"Resubmit template to Meta","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/templates/resubmit","href":"/api-reference/templates/resubmit-template-to-meta"},{"title":"Sync templates from Meta","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/templates/sync","href":"/api-reference/templates/sync-templates-from-meta"},{"title":"Upload template media","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/templates/upload-media","href":"/api-reference/templates/upload-template-media"},{"title":"Get template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/templates/{templateId}","href":"/api-reference/templates/get-template"},{"title":"Update template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/templates/{templateId}","href":"/api-reference/templates/update-template"},{"title":"Delete template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/templates/{templateId}","href":"/api-reference/templates/delete-template"},{"title":"List template categories","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/templates/categories","href":"/api-reference/templates/list-template-categories"}]},{"group":"Workflows","pages":[{"title":"List workflows","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/workflows","href":"/api-reference/workflows/list-workflows"},{"title":"Create workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/workflows","href":"/api-reference/workflows/create-workflow"},{"title":"Create workflow from template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/workflows/from-template/{templateId}","href":"/api-reference/workflows/create-workflow-from-template"},{"title":"List workflow templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/workflows/templates","href":"/api-reference/workflows/list-workflow-templates"},{"title":"Get workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/workflows/{workflowId}","href":"/api-reference/workflows/get-workflow"},{"title":"Update workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/workflows/{workflowId}","href":"/api-reference/workflows/update-workflow"},{"title":"Delete workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/workflows/{workflowId}","href":"/api-reference/workflows/delete-workflow"},{"title":"Publish workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/workflows/{workflowId}/publish","href":"/api-reference/workflows/publish-workflow"},{"title":"Revert workflow version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/workflows/{workflowId}/revert/{version}","href":"/api-reference/workflows/revert-workflow-version"},{"title":"Save workflow draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/workflows/{workflowId}/save-draft","href":"/api-reference/workflows/save-workflow-draft"},{"title":"Toggle workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/workflows/{workflowId}/toggle","href":"/api-reference/workflows/toggle-workflow"},{"title":"List workflow versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/workflows/{workflowId}/versions","href":"/api-reference/workflows/list-workflow-versions"},{"title":"List all workflow templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/workflows/templates/all","href":"/api-reference/workflows/list-all-workflow-templates"}]},{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /core/accounts/{account_id}/agents","href":"/api-reference/agents/list-agents"},{"title":"Create agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/agents","href":"/api-reference/agents/create-agent"},{"title":"Bulk create agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/agents/bulk_create","href":"/api-reference/agents/bulk-create-agents"},{"title":"Delete agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /core/accounts/{account_id}/agents/{id}","href":"/api-reference/agents/delete-agent"},{"title":"Update agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /core/accounts/{account_id}/agents/{id}","href":"/api-reference/agents/update-agent"}]},{"group":"Conversations","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /core/accounts/{account_id}/conversations","href":"/api-reference/conversations/list-conversations"},{"title":"Create a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations","href":"/api-reference/conversations/create-a-conversation"},{"title":"Filter conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/filter","href":"/api-reference/conversations/filter-conversations"},{"title":"Get conversation meta counts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /core/accounts/{account_id}/conversations/meta","href":"/api-reference/conversations/get-conversation-meta-counts"},{"title":"Search conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /core/accounts/{account_id}/conversations/search","href":"/api-reference/conversations/search-conversations"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /core/accounts/{account_id}/conversations/{conversation_id}","href":"/api-reference/conversations/get-a-conversation"},{"title":"Delete a conversation (moves it to Archived)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /core/accounts/{account_id}/conversations/{conversation_id}","href":"/api-reference/conversations/delete-a-conversation-moves-it-to-archived"},{"title":"Update a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /core/accounts/{account_id}/conversations/{conversation_id}","href":"/api-reference/conversations/update-a-conversation"},{"title":"Restore an archived conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/restore","href":"/api-reference/conversations/restore-an-archived-conversation"},{"title":"Update conversation assignments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/assignments","href":"/api-reference/conversations/update-conversation-assignments"},{"title":"List conversation attachments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /core/accounts/{account_id}/conversations/{conversation_id}/attachments","href":"/api-reference/conversations/list-conversation-attachments"},{"title":"Update custom attributes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/custom_attributes","href":"/api-reference/conversations/update-custom-attributes"},{"title":"List conversation labels","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /core/accounts/{account_id}/conversations/{conversation_id}/labels","href":"/api-reference/conversations/list-conversation-labels"},{"title":"Update conversation labels","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/labels","href":"/api-reference/conversations/update-conversation-labels"},{"title":"Mute a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/mute","href":"/api-reference/conversations/mute-a-conversation"},{"title":"List conversation participants","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /core/accounts/{account_id}/conversations/{conversation_id}/participants","href":"/api-reference/conversations/list-conversation-participants"},{"title":"Update conversation participants","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /core/accounts/{account_id}/conversations/{conversation_id}/participants","href":"/api-reference/conversations/update-conversation-participants"},{"title":"Toggle conversation priority","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/toggle_priority","href":"/api-reference/conversations/toggle-conversation-priority"},{"title":"Toggle conversation status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/toggle_status","href":"/api-reference/conversations/toggle-conversation-status"},{"title":"Toggle typing status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/toggle_typing_status","href":"/api-reference/conversations/toggle-typing-status"},{"title":"Send conversation transcript","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/transcript","href":"/api-reference/conversations/send-conversation-transcript"},{"title":"Unmute a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/unmute","href":"/api-reference/conversations/unmute-a-conversation"},{"title":"Mark conversation as unread","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/unread","href":"/api-reference/conversations/mark-conversation-as-unread"},{"title":"Update last seen","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/update_last_seen","href":"/api-reference/conversations/update-last-seen"}]},{"group":"Messages","pages":[{"title":"List messages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /core/accounts/{account_id}/conversations/{conversation_id}/messages","href":"/api-reference/messages/list-messages"},{"title":"Create a message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/messages","href":"/api-reference/messages/create-a-message"},{"title":"Delete a message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /core/accounts/{account_id}/conversations/{conversation_id}/messages/{id}","href":"/api-reference/messages/delete-a-message"},{"title":"Retry a message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/messages/{id}/retry","href":"/api-reference/messages/retry-a-message"},{"title":"Translate a message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/conversations/{conversation_id}/messages/{id}/translate","href":"/api-reference/messages/translate-a-message"}]},{"group":"Inboxes","pages":[{"title":"List inboxes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /core/accounts/{account_id}/inboxes","href":"/api-reference/inboxes/list-inboxes"},{"title":"Create inbox","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/inboxes","href":"/api-reference/inboxes/create-inbox"},{"title":"Show inbox","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /core/accounts/{account_id}/inboxes/{id}","href":"/api-reference/inboxes/show-inbox"},{"title":"Delete inbox","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /core/accounts/{account_id}/inboxes/{id}","href":"/api-reference/inboxes/delete-inbox"},{"title":"Update inbox","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /core/accounts/{account_id}/inboxes/{id}","href":"/api-reference/inboxes/update-inbox"}]},{"group":"Teams","pages":[{"title":"List teams","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /core/accounts/{account_id}/teams","href":"/api-reference/teams/list-teams"},{"title":"Create team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /core/accounts/{account_id}/teams","href":"/api-reference/teams/create-team"},{"title":"Show team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /core/accounts/{account_id}/teams/{id}","href":"/api-reference/teams/show-team"},{"title":"Delete team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /core/accounts/{account_id}/teams/{id}","href":"/api-reference/teams/delete-team"},{"title":"Update team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /core/accounts/{account_id}/teams/{id}","href":"/api-reference/teams/update-team"}]},{"group":"Sales CRM","pages":[{"title":"List Sales Leads","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/leads","href":"/api-reference/sales-crm/list-sales-leads"},{"title":"Create a Sales Lead","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/leads","href":"/api-reference/sales-crm/create-a-sales-lead"},{"title":"Get a Sales Lead","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/leads/{leadId}","href":"/api-reference/sales-crm/get-a-sales-lead"},{"title":"Update a Sales Lead","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/leads/{leadId}","href":"/api-reference/sales-crm/update-a-sales-lead"},{"title":"Update Lead qualification status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/leads/{leadId}/status","href":"/api-reference/sales-crm/update-lead-qualification-status"},{"title":"Convert a qualified Lead","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/leads/{leadId}/convert","href":"/api-reference/sales-crm/convert-a-qualified-lead"},{"title":"Get Lead history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/leads/{leadId}/history","href":"/api-reference/sales-crm/get-lead-history"},{"title":"List Sales products","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/products","href":"/api-reference/sales-crm/list-sales-products"},{"title":"Create a Sales product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/products","href":"/api-reference/sales-crm/create-a-sales-product"},{"title":"Archive or restore a Sales product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/accounts/{accountId}/sales/products/{productId}/active","href":"/api-reference/sales-crm/archive-or-restore-a-sales-product"},{"title":"List Sales price books","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/price-books","href":"/api-reference/sales-crm/list-sales-price-books"},{"title":"Create a Sales price book","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/price-books","href":"/api-reference/sales-crm/create-a-sales-price-book"},{"title":"List price-book entries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/price-books/{priceBookId}/entries","href":"/api-reference/sales-crm/list-price-book-entries"},{"title":"Add a price-book entry","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/price-books/{priceBookId}/entries","href":"/api-reference/sales-crm/add-a-price-book-entry"},{"title":"List Sales quotes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/quotes","href":"/api-reference/sales-crm/list-sales-quotes"},{"title":"Create a Sales quote","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/quotes","href":"/api-reference/sales-crm/create-a-sales-quote"},{"title":"List Deals","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/deals","href":"/api-reference/sales-crm/list-deals"},{"title":"Create a Deal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/deals","href":"/api-reference/sales-crm/create-a-deal"},{"title":"Move a Deal stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/deals/{dealId}/move","href":"/api-reference/sales-crm/move-a-deal-stage"},{"title":"Bulk assign Sales Leads","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/leads/bulk-assign","href":"/api-reference/sales-crm/bulk-assign-sales-leads"},{"title":"Find the Lead linked to a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/leads/by-conversation/{conversationId}","href":"/api-reference/sales-crm/find-the-lead-linked-to-a-conversation"},{"title":"Export Sales Leads","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/leads/export","href":"/api-reference/sales-crm/export-sales-leads"},{"title":"Assign a Lead","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/leads/{leadId}/assign","href":"/api-reference/sales-crm/assign-a-lead"},{"title":"Review Lead duplicate candidates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/leads/{leadId}/duplicates","href":"/api-reference/sales-crm/review-lead-duplicate-candidates"},{"title":"Upload a Lead file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/leads/{leadId}/files","href":"/api-reference/sales-crm/upload-a-lead-file"},{"title":"Download a Lead file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/leads/{leadId}/files/{fileId}","href":"/api-reference/sales-crm/download-a-lead-file"},{"title":"Delete a Lead file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/leads/{leadId}/files/{fileId}","href":"/api-reference/sales-crm/delete-a-lead-file"},{"title":"Move a Lead on the qualification board","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/leads/{leadId}/move","href":"/api-reference/sales-crm/move-a-lead-on-the-qualification-board"},{"title":"Add a Lead note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/leads/{leadId}/notes","href":"/api-reference/sales-crm/add-a-lead-note"},{"title":"List native Companies","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/companies","href":"/api-reference/sales-crm/list-native-companies"},{"title":"Create a Company","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/companies","href":"/api-reference/sales-crm/create-a-company"},{"title":"Get a Company record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/companies/{companyId}","href":"/api-reference/sales-crm/get-a-company-record"},{"title":"Update a Company record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/sales/companies/{companyId}","href":"/api-reference/sales-crm/update-a-company-record"},{"title":"Archive or restore a Company","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/accounts/{accountId}/sales/companies/{companyId}/archive","href":"/api-reference/sales-crm/archive-or-restore-a-company"},{"title":"Add a Company contact role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/companies/{companyId}/contact-roles","href":"/api-reference/sales-crm/add-a-company-contact-role"},{"title":"Remove a Company contact role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/sales/companies/{companyId}/contact-roles/{roleId}","href":"/api-reference/sales-crm/remove-a-company-contact-role"},{"title":"Upload a Company file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/companies/{companyId}/files","href":"/api-reference/sales-crm/upload-a-company-file"},{"title":"Download a Company file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/companies/{companyId}/files/{fileId}","href":"/api-reference/sales-crm/download-a-company-file"},{"title":"Delete a Company file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/sales/companies/{companyId}/files/{fileId}","href":"/api-reference/sales-crm/delete-a-company-file"},{"title":"Add a Company note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/companies/{companyId}/notes","href":"/api-reference/sales-crm/add-a-company-note"},{"title":"Get the full Deal record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/deals/{dealId}","href":"/api-reference/sales-crm/get-the-full-deal-record"},{"title":"Update the full Deal record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/sales/deals/{dealId}","href":"/api-reference/sales-crm/update-the-full-deal-record"},{"title":"Add a Deal contact role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/deals/{dealId}/contact-roles","href":"/api-reference/sales-crm/add-a-deal-contact-role"},{"title":"Remove a Deal contact role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/sales/deals/{dealId}/contact-roles/{roleId}","href":"/api-reference/sales-crm/remove-a-deal-contact-role"},{"title":"Upload a Deal file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/deals/{dealId}/files","href":"/api-reference/sales-crm/upload-a-deal-file"},{"title":"Download a Deal file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/deals/{dealId}/files/{fileId}","href":"/api-reference/sales-crm/download-a-deal-file"},{"title":"Delete a Deal file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/sales/deals/{dealId}/files/{fileId}","href":"/api-reference/sales-crm/delete-a-deal-file"},{"title":"Add a product to a Deal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/deals/{dealId}/line-items","href":"/api-reference/sales-crm/add-a-product-to-a-deal"},{"title":"Remove a Deal line item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/sales/deals/{dealId}/line-items/{lineItemId}","href":"/api-reference/sales-crm/remove-a-deal-line-item"},{"title":"Add a Deal note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/deals/{dealId}/notes","href":"/api-reference/sales-crm/add-a-deal-note"},{"title":"Get Sales forecast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/forecast","href":"/api-reference/sales-crm/get-sales-forecast"},{"title":"Save a Sales quota","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/sales/forecast/quotas","href":"/api-reference/sales-crm/save-a-sales-quota"},{"title":"Capture a Sales forecast snapshot","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/forecast/snapshots","href":"/api-reference/sales-crm/capture-a-sales-forecast-snapshot"},{"title":"Get Sales overview","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/overview","href":"/api-reference/sales-crm/get-sales-overview"},{"title":"Get a Sales price book","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/price-books/{priceBookId}","href":"/api-reference/sales-crm/get-a-sales-price-book"},{"title":"Update a Sales price book","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/sales/price-books/{priceBookId}","href":"/api-reference/sales-crm/update-a-sales-price-book"},{"title":"Clone a Sales price book","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/price-books/{priceBookId}/clone","href":"/api-reference/sales-crm/clone-a-sales-price-book"},{"title":"Update a price-book entry","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/sales/price-books/{priceBookId}/entries/{entryId}","href":"/api-reference/sales-crm/update-a-price-book-entry"},{"title":"Delete a price-book entry","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/sales/price-books/{priceBookId}/entries/{entryId}","href":"/api-reference/sales-crm/delete-a-price-book-entry"},{"title":"Get a Sales product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/products/{productId}","href":"/api-reference/sales-crm/get-a-sales-product"},{"title":"Update a Sales product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/sales/products/{productId}","href":"/api-reference/sales-crm/update-a-sales-product"},{"title":"Get a Sales quote","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/quotes/{quoteId}","href":"/api-reference/sales-crm/get-a-sales-quote"},{"title":"Edit an unshared Sales quote draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/sales/quotes/{quoteId}","href":"/api-reference/sales-crm/edit-an-unshared-sales-quote-draft"},{"title":"Decide a quote approval","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/accounts/{accountId}/sales/quotes/{quoteId}/approval","href":"/api-reference/sales-crm/decide-a-quote-approval"},{"title":"Update quote lifecycle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/accounts/{accountId}/sales/quotes/{quoteId}/lifecycle","href":"/api-reference/sales-crm/update-quote-lifecycle"},{"title":"Create a payment request record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/quotes/{quoteId}/payment-requests","href":"/api-reference/sales-crm/create-a-payment-request-record"},{"title":"View or download a quotation PDF","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/quotes/{quoteId}/pdf","href":"/api-reference/sales-crm/view-or-download-a-quotation-pdf"},{"title":"Upload or replace a quotation PDF","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/quotes/{quoteId}/pdf","href":"/api-reference/sales-crm/upload-or-replace-a-quotation-pdf"},{"title":"Remove a quotation PDF","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/sales/quotes/{quoteId}/pdf","href":"/api-reference/sales-crm/remove-a-quotation-pdf"},{"title":"Create a quote revision","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/quotes/{quoteId}/revisions","href":"/api-reference/sales-crm/create-a-quote-revision"},{"title":"Get Sales reports","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/reports","href":"/api-reference/sales-crm/get-sales-reports"},{"title":"List saved Sales views","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/saved-views","href":"/api-reference/sales-crm/list-saved-sales-views"},{"title":"Create a saved Sales view","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/saved-views","href":"/api-reference/sales-crm/create-a-saved-sales-view"},{"title":"Delete a saved Sales view","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/sales/saved-views/{viewId}","href":"/api-reference/sales-crm/delete-a-saved-sales-view"},{"title":"Get Sales settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/settings","href":"/api-reference/sales-crm/get-sales-settings"},{"title":"Save Sales settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/sales/settings","href":"/api-reference/sales-crm/save-sales-settings"},{"title":"List unified Sales tasks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/tasks","href":"/api-reference/sales-crm/list-unified-sales-tasks"},{"title":"Create a Sales task","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/tasks","href":"/api-reference/sales-crm/create-a-sales-task"},{"title":"Update a Sales task","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/sales/tasks/{taskId}","href":"/api-reference/sales-crm/update-a-sales-task"},{"title":"Delete a Sales task","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/accounts/{accountId}/sales/tasks/{taskId}","href":"/api-reference/sales-crm/delete-a-sales-task"},{"title":"Change a Sales task status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/accounts/{accountId}/sales/tasks/{taskId}/status","href":"/api-reference/sales-crm/change-a-sales-task-status"},{"title":"Create or rotate a private quote link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/quotes/{quoteId}/share-link","href":"/api-reference/sales-crm/create-or-rotate-a-private-quote-link"},{"title":"Decide a deal line-item discount approval","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v2/accounts/{accountId}/sales/deals/{dealId}/line-items/{lineItemId}/approval","href":"/api-reference/sales-crm/decide-a-deal-line-item-discount-approval"},{"title":"Get a Sales pipeline definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/pipelines/{pipelineId}/definition","href":"/api-reference/sales-crm/get-a-sales-pipeline-definition"},{"title":"Save a Sales pipeline definition atomically","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/sales/pipelines/{pipelineId}/definition","href":"/api-reference/sales-crm/save-a-sales-pipeline-definition-atomically"},{"title":"Search products available for a price book","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/price-books/{priceBookId}/candidates","href":"/api-reference/sales-crm/search-products-available-for-a-price-book"},{"title":"Add price-book entries atomically","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/accounts/{accountId}/sales/price-books/{priceBookId}/entries/batch","href":"/api-reference/sales-crm/add-price-book-entries-atomically"},{"title":"List quote versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/quotes/{quoteId}/versions","href":"/api-reference/sales-crm/list-quote-versions"},{"title":"Get Sales working hours","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/accounts/{accountId}/sales/working-hours/{inboxId}","href":"/api-reference/sales-crm/get-sales-working-hours"},{"title":"Save Sales working hours","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v2/accounts/{accountId}/sales/working-hours/{inboxId}","href":"/api-reference/sales-crm/save-sales-working-hours"}]}]}]}]}]},"title":"List appointments and catalog - HueChat","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-D5fEM6aW.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}