{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"YCloud Docs","description":"YCloud product documentation, API reference, and webhook payload documentation.","colors":{"primary":"#602DED","light":"#FD4C7D","dark":"#1a1e22"},"logo":{"light":"https://mintcdn.com/lchnan/AXn0jsI-c5aPnOMW/logo/light.png?fit=max\u0026auto=format\u0026n=AXn0jsI-c5aPnOMW\u0026q=85\u0026s=0865e4207d765d07a769c29bc819adbe","dark":"https://mintcdn.com/lchnan/AXn0jsI-c5aPnOMW/logo/dark.png?fit=max\u0026auto=format\u0026n=AXn0jsI-c5aPnOMW\u0026q=85\u0026s=1bafffbe886c0ac13b0409dc90d446f8","href":"https://www.ycloud.com"},"favicon":"https://mintcdn.com/lchnan/AXn0jsI-c5aPnOMW/favicon.png?fit=max\u0026auto=format\u0026n=AXn0jsI-c5aPnOMW\u0026q=85\u0026s=1eed9e0b562f4b06368d2b8185b801b4","api":{"openapi":["openapi/endpoints/ycloud-api-v2.yaml","openapi/webhooks/testing-webhooks.yaml"],"params":{"expanded":"closed"},"playground":{"display":"interactive"},"examples":{"defaults":"required","prefill":true,"autogenerate":false},"url":"full"},"background":{"color":{"light":"#ffffff"}},"navbar":{"links":[{"href":"https://www.ycloud.com/customer-support","label":"Support"},{"href":"https://www.ycloud.com/pricing","label":"Pricing"}],"primary":{"type":"button","label":"Dashboard","href":"https://www.ycloud.com/console"}},"seo":{"indexing":"all"},"fonts":{"heading":{"family":"Inter","weight":650},"body":{"family":"Inter","weight":450}},"icons":{"library":"fontawesome"},"styling":{"codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":true},"errors":{"404":{"redirect":true}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"markdown":{"schema":true},"navigation":{"languages":[{"language":"en","default":true,"href":"en/documentation/overview"},{"language":"zh","href":"zh/documentation/overview"},{"language":"es","href":"es/documentation/overview"},{"language":"pt","href":"pt/documentation/overview"},{"language":"ru","href":"ru/documentation/overview"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lchnan","hasAudioNarration":false,"actualSubdomain":"lchnan","customDomains":["docs.ycloud.com"],"gitSource":{"type":"github","owner":"ycloud-developers","repo":"ycloud_docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"38a7c79a-935e-44ce-8ac4-771d9347bc89","liveDeploymentHistoryId":"6ae201baf9cefd8f8d7a475b","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae201baf9cefd8f8d7a475b"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae201baf9cefd8f8d7a475b","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"en","tag":"Documentation","count":242},{"language":"es","tag":"Documentación","count":241},{"language":"pt","tag":"Documentação","count":241},{"language":"ru","tag":"Документация","count":241},{"language":"zh","tag":"产品文档","count":241},{"language":"default","tag":"API Reference","count":165},{"language":"default","tag":"Endpoints","count":165},{"language":"en","tag":"API Reference","count":68},{"language":"es","tag":"Referencia de la API","count":68},{"language":"pt","tag":"Referência da API","count":68},{"language":"ru","tag":"Справочник API","count":68},{"language":"zh","tag":"API 参考","count":68},{"language":"en","tag":"Guides","count":63},{"language":"es","tag":"Guías","count":63},{"language":"pt","tag":"Guias","count":63},{"language":"ru","tag":"Руководства","count":63},{"language":"zh","tag":"指南","count":63},{"language":"default","tag":"Meta Business Agent","count":63},{"language":"en","tag":"Channels","count":60},{"language":"es","tag":"Gestión de cuentas de WhatsApp","count":54},{"language":"pt","tag":"Gerenciamento de contas do WhatsApp","count":54},{"language":"ru","tag":"Управление аккаунтами WhatsApp","count":54},{"language":"zh","tag":"WhatsApp 账号管理","count":54},{"language":"en","tag":"Integrations","count":44},{"language":"es","tag":"Integraciones","count":44},{"language":"pt","tag":"Integrações","count":44},{"language":"ru","tag":"Интеграции","count":44},{"language":"zh","tag":"集成","count":44},{"language":"default","tag":"Configure","count":43},{"language":"en","tag":"WhatsApp Business Platform","count":40},{"language":"es","tag":"WhatsApp Business Platform","count":40},{"language":"pt","tag":"WhatsApp Business Platform","count":40},{"language":"ru","tag":"Платформа WhatsApp Business","count":40},{"language":"zh","tag":"WhatsApp 商业平台","count":40},{"language":"es","tag":"Canales","count":32},{"language":"pt","tag":"Canais","count":32},{"language":"ru","tag":"Каналы","count":32},{"language":"zh","tag":"渠道","count":32},{"language":"en","tag":"Examples","count":28},{"language":"en","tag":"WhatsApp Accounts Management","count":28},{"language":"es","tag":"Ejemplos","count":28},{"language":"pt","tag":"Exemplos","count":28},{"language":"ru","tag":"Примеры","count":28},{"language":"zh","tag":"示例","count":28},{"language":"en","tag":"Webhook examples","count":25},{"language":"en","tag":"Agents","count":25},{"language":"es","tag":"Ejemplos de Webhook","count":25},{"language":"es","tag":"Agentes","count":25},{"language":"pt","tag":"Exemplos de Webhook","count":25},{"language":"pt","tag":"Agentes","count":25},{"language":"ru","tag":"Примеры Webhook","count":25},{"language":"ru","tag":"Агенты","count":25},{"language":"zh","tag":"Webhook 示例","count":25},{"language":"zh","tag":"智能体","count":25},{"language":"default","tag":"WhatsApp Phone Numbers","count":15},{"language":"default","tag":"WhatsApp Groups","count":12},{"language":"default","tag":"Contacts","count":10},{"language":"default","tag":"Operate","count":10},{"language":"default","tag":"Connectors","count":10},{"language":"default","tag":"Onboard","count":9}],"searchSettings":{"isFiltersEnabled":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"zh/api-reference/meta-business-agents/operate","slug":"/zh/api-reference/meta-business-agents/operate","pageMetadata":{"title":"操作概览","description":"测试代理响应、检查对话轮次、运行评估、提交事件并控制实时客户对话线程。","href":"/zh/api-reference/meta-business-agents/operate"},"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: \"测试代理响应、检查对话轮次、运行评估、提交事件并控制实时客户对话线程。\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components},{Card,CardGroup}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`在代理上线且其初始配置可用后使用这些资源。`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Agent Eval`,href:`/api-reference/meta-business-agents/list-eval-cases`,children:`运行评估用例并检查详细或汇总结果。`}),_jsx(Card,{title:`Agent Event`,href:`/api-reference/meta-business-agents/submit-agent-event`,children:`提交业务事件并轮询其处理状态。`}),_jsx(Card,{title:`Agent Test`,href:`/api-reference/meta-business-agents/test-agent`,children:`运行单轮和上下文多轮测试。`}),_jsx(Card,{title:`Conversation Turns`,href:`/api-reference/meta-business-agents/get-conversation-turns`,children:`检查 WhatsApp 用户对话轮次的 LLM 和工具调用步骤。`}),_jsx(Card,{title:`Thread Control (Cloud API)`,href:`/api-reference/meta-business-agents/control-thread`,children:`传递、释放或接管客户对话线程的控制权。`})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"title":"操作概览","description":"测试代理响应、检查对话轮次、运行评估、提交事件并控制实时客户对话线程。","href":"/zh/api-reference/meta-business-agents/operate"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"lchnan","siteName":"YCloud Docs","title":"操作概览 - YCloud Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/zh/api-reference/meta-business-agents/operate","matchLevel":0},"zh":{"href":"/zh/documentation/overview","matchLevel":4},"es":{"href":"/es/documentation/overview","matchLevel":4},"pt":{"href":"/pt/documentation/overview","matchLevel":4},"ru":{"href":"/ru/documentation/overview","matchLevel":4}}},"lastModified":"2026-09-04T08:09:52.653Z","originalFileLocation":"zh/api-reference/meta-business-agents/operate.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=\"测试代理响应、检查对话轮次、运行评估、提交事件并控制实时客户对话线程。\">\u003cmeta data-mint-head name=\"application-name\" content=\"YCloud Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lchnan/g_kuIVCsIE9hrH5P/_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/lchnan/g_kuIVCsIE9hrH5P/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lchnan/g_kuIVCsIE9hrH5P/_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/lchnan/g_kuIVCsIE9hrH5P/_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/lchnan/g_kuIVCsIE9hrH5P/_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/lchnan/g_kuIVCsIE9hrH5P/_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/lchnan/g_kuIVCsIE9hrH5P/_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/lchnan/g_kuIVCsIE9hrH5P/_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/lchnan/g_kuIVCsIE9hrH5P/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"操作概览 - YCloud Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"测试代理响应、检查对话轮次、运行评估、提交事件并控制实时客户对话线程。\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"YCloud Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ycloud.com/zh/api-reference/meta-business-agents/operate\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://lchnan.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=%E6%93%8D%E4%BD%9C%E6%A6%82%E8%A7%88\u0026amp;description=%E6%B5%8B%E8%AF%95%E4%BB%A3%E7%90%86%E5%93%8D%E5%BA%94%E3%80%81%E6%A3%80%E6%9F%A5%E5%AF%B9%E8%AF%9D%E8%BD%AE%E6%AC%A1%E3%80%81%E8%BF%90%E8%A1%8C%E8%AF%84%E4%BC%B0%E3%80%81%E6%8F%90%E4%BA%A4%E4%BA%8B%E4%BB%B6%E5%B9%B6%E6%8E%A7%E5%88%B6%E5%AE%9E%E6%97%B6%E5%AE%A2%E6%88%B7%E5%AF%B9%E8%AF%9D%E7%BA%BF%E7%A8%8B%E3%80%82\u0026amp;theme=7e639de6347778391fbe3ad7\u0026amp;signature=1b0648c8f16863147278975dc1b1dcdae4d4884d3feb0fd908d14aeb8179ea4c\">\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=\"操作概览 - YCloud Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"测试代理响应、检查对话轮次、运行评估、提交事件并控制实时客户对话线程。\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lchnan.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=%E6%93%8D%E4%BD%9C%E6%A6%82%E8%A7%88\u0026amp;description=%E6%B5%8B%E8%AF%95%E4%BB%A3%E7%90%86%E5%93%8D%E5%BA%94%E3%80%81%E6%A3%80%E6%9F%A5%E5%AF%B9%E8%AF%9D%E8%BD%AE%E6%AC%A1%E3%80%81%E8%BF%90%E8%A1%8C%E8%AF%84%E4%BC%B0%E3%80%81%E6%8F%90%E4%BA%A4%E4%BA%8B%E4%BB%B6%E5%B9%B6%E6%8E%A7%E5%88%B6%E5%AE%9E%E6%97%B6%E5%AE%A2%E6%88%B7%E5%AF%B9%E8%AF%9D%E7%BA%BF%E7%A8%8B%E3%80%82\u0026amp;theme=7e639de6347778391fbe3ad7\u0026amp;signature=1b0648c8f16863147278975dc1b1dcdae4d4884d3feb0fd908d14aeb8179ea4c\">\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/lchnan/g_kuIVCsIE9hrH5P/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"YCloud Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#602DED\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.ycloud.com/zh/api-reference/meta-business-agents/operate\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/zh/api-reference/meta-business-agents/operate.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.ycloud.com/#organization\",\"name\":\"YCloud Docs\",\"url\":\"https://docs.ycloud.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/lchnan/AXn0jsI-c5aPnOMW/logo/light.png?fit=max\u0026auto=format\u0026n=AXn0jsI-c5aPnOMW\u0026q=85\u0026s=0865e4207d765d07a769c29bc819adbe\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.ycloud.com#website\",\"name\":\"YCloud Docs\",\"url\":\"https://docs.ycloud.com\",\"publisher\":{\"@id\":\"https://docs.ycloud.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.ycloud.com/zh/api-reference/meta-business-agents/operate#webpage\",\"url\":\"https://docs.ycloud.com/zh/api-reference/meta-business-agents/operate\",\"name\":\"操作概览\",\"description\":\"测试代理响应、检查对话轮次、运行评估、提交事件并控制实时客户对话线程。\",\"dateModified\":\"2026-09-04T08:09:52.653Z\",\"isPartOf\":{\"@id\":\"https://docs.ycloud.com#website\"}},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.ycloud.com/zh/api-reference/meta-business-agents/operate#article\",\"headline\":\"操作概览\",\"name\":\"操作概览\",\"description\":\"测试代理响应、检查对话轮次、运行评估、提交事件并控制实时客户对话线程。\",\"url\":\"https://docs.ycloud.com/zh/api-reference/meta-business-agents/operate\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ycloud.com/zh/api-reference/meta-business-agents/operate#webpage\"},\"dateModified\":\"2026-09-04T08:09:52.653Z\",\"publisher\":{\"@id\":\"https://docs.ycloud.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.ycloud.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"YCloud Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"YCloud Docs","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Documentation","icon":"book-open","groups":[{"group":"Overview","pages":[{"title":"Welcome to YCloud Docs","href":"/en/documentation/overview"},{"group":"Update Log","pages":[{"title":"Update Log","href":"/en/documentation/overview/update-log/index"},{"title":"WhatsApp pricing update and Message limit changes on Oct.","href":"/en/documentation/overview/update-log/whatsapp-pricing-update-and-message-limit-changes-on-oct"}]}]},{"group":"Quick Start","pages":[{"title":"Connect WhatsApp to YCloud","href":"/en/documentation/quick-start/connect-whatsapp-to-ycloud"},{"title":"Send verification codes via WhatsApp","href":"/en/documentation/quick-start/send-verification-codes-via-whatsapp"},{"title":"Send utility messages via WhatsApp","href":"/en/documentation/quick-start/send-utility-messages-via-whatsapp"},{"title":"Acquire customers with Click-to-WhatsApp ads","href":"/en/documentation/quick-start/acquire-customers-with-click-to-whatsapp-ads"},{"title":"Run marketing campaigns via WhatsApp","href":"/en/documentation/quick-start/run-marketing-campaigns-via-whatsapp"},{"title":"Set up customer support via WhatsApp","href":"/en/documentation/quick-start/set-up-customer-support-via-whatsapp"}]},{"group":"WhatsApp Business Platform","pages":[{"title":"Overview","href":"/en/documentation/whatsapp-business-platform/overview"},{"group":"Accounts and business identity","pages":[{"title":"Account structure and WABAs","href":"/en/documentation/whatsapp-business-platform/accounts-and-business-identity/account-structure-and-wabas"},{"title":"Business phone numbers","href":"/en/documentation/whatsapp-business-platform/accounts-and-business-identity/business-phone-numbers"},{"title":"Business verification","href":"/en/documentation/whatsapp-business-platform/accounts-and-business-identity/business-verification"},{"title":"Official Business Accounts","href":"/en/documentation/whatsapp-business-platform/accounts-and-business-identity/official-business-accounts"},{"title":"WhatsApp Business App coexistence","href":"/en/documentation/whatsapp-business-platform/accounts-and-business-identity/whatsapp-business-app-coexistence"}]},{"group":"Messaging","pages":[{"title":"How messaging works","href":"/en/documentation/whatsapp-business-platform/messaging/how-messaging-works"},{"group":"Message templates","pages":[{"title":"Template overview","href":"/en/documentation/whatsapp-business-platform/messaging/message-templates/index"},{"title":"Marketing templates","href":"/en/documentation/whatsapp-business-platform/messaging/message-templates/marketing-templates"},{"title":"Utility templates","href":"/en/documentation/whatsapp-business-platform/messaging/message-templates/utility-templates"},{"title":"Authentication templates","href":"/en/documentation/whatsapp-business-platform/messaging/message-templates/authentication-message-templates/index"},{"title":"Template components and formats","href":"/en/documentation/whatsapp-business-platform/messaging/message-templates/template-components-and-formats"},{"title":"Template review and lifecycle","href":"/en/documentation/whatsapp-business-platform/messaging/message-templates/template-review-and-lifecycle"},{"group":"Authentication Message Templates","hidden":true,"pages":[{"title":"Copy-code authentication","href":"/en/documentation/whatsapp-business-platform/messaging/message-templates/authentication-message-templates/copy-code-authentication"},{"title":"One-tap authentication","href":"/en/documentation/whatsapp-business-platform/messaging/message-templates/authentication-message-templates/one-tap-authentication"},{"title":"Zero-tap authentication","href":"/en/documentation/whatsapp-business-platform/messaging/message-templates/authentication-message-templates/zero-tap-authentication"}]},{"title":"Catalog templates","hidden":true,"href":"/en/documentation/whatsapp-business-platform/messaging/message-templates/catalog-templates"},{"title":"Carousel templates","hidden":true,"href":"/en/documentation/whatsapp-business-platform/messaging/message-templates/carousel-templates"},{"title":"Coupon-code templates","hidden":true,"href":"/en/documentation/whatsapp-business-platform/messaging/message-templates/coupon-code-templates"},{"title":"Limited-time offer templates","hidden":true,"href":"/en/documentation/whatsapp-business-platform/messaging/message-templates/limited-time-offer-templates"},{"title":"Multi-product templates","hidden":true,"href":"/en/documentation/whatsapp-business-platform/messaging/message-templates/multi-product-templates"}]},{"title":"Service messages","href":"/en/documentation/whatsapp-business-platform/messaging/service-messages"},{"title":"Message delivery statuses","href":"/en/documentation/whatsapp-business-platform/messaging/message-delivery-statuses"}]},{"group":"Pricing, limits, and quality","pages":[{"title":"WhatsApp pricing","href":"/en/documentation/whatsapp-business-platform/pricing-limits-and-quality/whatsapp-pricing"},{"title":"Authentication-international rates","href":"/en/documentation/whatsapp-business-platform/pricing-limits-and-quality/authentication-international-rates"},{"title":"Max Price for WhatsApp marketing messages","href":"/en/documentation/whatsapp-business-platform/pricing-limits-and-quality/max-price-for-marketing-messages"},{"title":"Messaging limits and throughput","href":"/en/documentation/whatsapp-business-platform/pricing-limits-and-quality/messaging-limits-and-throughput"},{"title":"Quality and delivery controls","href":"/en/documentation/whatsapp-business-platform/pricing-limits-and-quality/quality-and-delivery-controls"}]},{"group":"Consent, policies, and account health","pages":[{"title":"Customer opt-in","href":"/en/documentation/whatsapp-business-platform/consent-policies-and-account-health/customer-opt-in"},{"title":"Customer opt-out","href":"/en/documentation/whatsapp-business-platform/consent-policies-and-account-health/customer-opt-out"},{"title":"Business and commerce policies","href":"/en/documentation/whatsapp-business-platform/consent-policies-and-account-health/business-and-commerce-policies"},{"title":"Account restrictions and appeals","href":"/en/documentation/whatsapp-business-platform/consent-policies-and-account-health/account-restrictions-and-appeals"}]},{"group":"More WhatsApp Features","pages":[{"title":"WhatsApp Flows","href":"/en/documentation/whatsapp-business-platform/more-whatsapp-features/whatsapp-flows/index"},{"title":"WhatsApp Calling","href":"/en/documentation/whatsapp-business-platform/more-whatsapp-features/whatsapp-calling"},{"title":"WhatsApp Groups","href":"/en/documentation/whatsapp-business-platform/more-whatsapp-features/whatsapp-groups"},{"title":"Catalogs and commerce","href":"/en/documentation/whatsapp-business-platform/more-whatsapp-features/catalogs-and-commerce"},{"title":"Click-to-WhatsApp ads","href":"/en/documentation/whatsapp-business-platform/more-whatsapp-features/click-to-whatsapp-ads"}]},{"group":"WhatsApp Flows","hidden":true,"pages":[{"title":"Create a WhatsApp Flow","href":"/en/documentation/whatsapp-business-platform/more-whatsapp-features/whatsapp-flows/create-a-whatsapp-flow"},{"title":"Send a WhatsApp Flow","href":"/en/documentation/whatsapp-business-platform/more-whatsapp-features/whatsapp-flows/send-a-whatsapp-flow"},{"title":"Review WhatsApp Flow submissions","href":"/en/documentation/whatsapp-business-platform/more-whatsapp-features/whatsapp-flows/review-whatsapp-flow-submissions"}]}]},{"group":"Channels","pages":[{"group":"WhatsApp Accounts Management","pages":[{"group":"WhatsApp business account","pages":[{"title":"Create WABA via Embedded Sign-up","href":"/en/documentation/channels/whatsapp-accounts-management/business-accounts/create-waba-via-embedded-sign-up"},{"title":"Add Numbers","href":"/en/documentation/channels/whatsapp-accounts-management/business-accounts/add-numbers"},{"title":"Number Migration","href":"/en/documentation/channels/whatsapp-accounts-management/business-accounts/number-migration"},{"title":"Remove WhatsApp business accounts","href":"/en/documentation/channels/whatsapp-accounts-management/business-accounts/remove-whatsapp-business-accounts"}]},{"group":"WhatsApp Business App Coexistence","pages":[{"title":"Onboard WhatsApp business app","href":"/en/documentation/channels/whatsapp-accounts-management/coexistence/onboard-whatsapp-business-app"},{"title":"Off-board WhatsApp Business App","href":"/en/documentation/channels/whatsapp-accounts-management/coexistence/off-board-whatsapp-business-app"},{"title":"Coexistence accounts migration","href":"/en/documentation/channels/whatsapp-accounts-management/coexistence/coexistence-accounts-migration"}]},{"group":"Template Management","pages":[{"group":"Create Template","pages":[{"title":"Create Template","href":"/en/documentation/channels/whatsapp-accounts-management/template-management/create-template/index"},{"title":"Create WhatsApp Flows Template","href":"/en/documentation/channels/whatsapp-accounts-management/template-management/create-template/create-whatsapp-flows-template"},{"title":"Create WhatsApp Pay Template","href":"/en/documentation/channels/whatsapp-accounts-management/template-management/create-template/create-whatsapp-pay-template"},{"title":"AI generates marketing templates","href":"/en/documentation/channels/whatsapp-accounts-management/template-management/create-template/ai-generates-marketing-templates"}]},{"title":"Template Library","sidebarTitle":"Template Library","href":"/en/documentation/channels/whatsapp-accounts-management/template-management/template-library"},{"title":"Test a message","sidebarTitle":"Test a message","href":"/en/documentation/channels/whatsapp-accounts-management/template-management/test-a-message"},{"title":"Copy Template","href":"/en/documentation/channels/whatsapp-accounts-management/template-management/copy-template"},{"title":"Template Analytics","href":"/en/documentation/channels/whatsapp-accounts-management/template-management/template-analytics"}]},{"group":"Phone Number Management","pages":[{"title":"Phone Number Management","href":"/en/documentation/channels/whatsapp-accounts-management/phone-number-management/index"},{"title":"Edit Phone Number Display Name ","href":"/en/documentation/channels/whatsapp-accounts-management/phone-number-management/edit-phone-number-display-name"},{"title":"Edit Phone Number Remark Name","href":"/untitled-page"},{"title":"Claim a Business Username","href":"/en/documentation/channels/whatsapp-accounts-management/phone-number-management/claim-a-business-username"},{"title":"Phone Number Profile Settings","href":"/en/documentation/channels/whatsapp-accounts-management/phone-number-management/phone-number-profile-settings"},{"title":"Authority","href":"/en/documentation/channels/whatsapp-accounts-management/phone-number-management/authority"},{"title":"Conversation Assignment Rules","href":"/en/documentation/channels/whatsapp-accounts-management/phone-number-management/conversation-assignment-rules"},{"title":"Automation","href":"/en/documentation/channels/whatsapp-accounts-management/phone-number-management/automation"},{"title":"Chat Links","href":"/en/documentation/channels/whatsapp-accounts-management/phone-number-management/chat-links"}]},{"title":"Account Disabling and Handling","href":"/en/documentation/channels/whatsapp-accounts-management/account-disabling-and-handling"},{"group":"Data Analysis","pages":[{"title":"Message Overview","href":"/en/documentation/channels/whatsapp-accounts-management/data-analysis/message-overview"},{"title":"Message Logs","href":"/en/documentation/channels/whatsapp-accounts-management/data-analysis/message-logs"},{"title":"Calling Logs","href":"/en/documentation/channels/whatsapp-accounts-management/data-analysis/calling-logs"}]}]}]},{"group":"Inbox","pages":[{"group":"Getting Started","pages":[{"title":"Inbox Introduction","href":"/en/documentation/inbox/inbox-introduction"},{"title":"Quick start with Inbox","href":"/en/documentation/inbox/quick-start-with-inbox"},{"title":"Admin Guide","href":"/en/documentation/inbox/admin-guide"},{"title":"Customer Support Guide","href":"/en/documentation/inbox/customer-support-guide"},{"title":"Inbox Mobile App","href":"/en/documentation/inbox/inbox-mobile-app"}]},{"group":"Conversations","pages":[{"title":"Initiate New Chat","href":"/en/documentation/inbox/initiate-new-chat"},{"title":"Search contacts \u0026 chat history","href":"/en/documentation/inbox/search-contacts-and-chat-history"},{"title":"Unsupported messages in Inbox","href":"/en/documentation/inbox/unsupported-messages-in-inbox"},{"title":"Message Translation","href":"/en/documentation/inbox/message-translation"},{"title":"WhatsApp Calling in Inbox","href":"/en/documentation/inbox/whatsapp-calling-in-inbox"},{"title":"AI Copilot","href":"/en/documentation/inbox/ai-copilot"}]},{"group":"Configuration","pages":[{"title":"Canned Response","href":"/en/documentation/inbox/canned-response"},{"title":"Welcome Messages","href":"/en/documentation/inbox/welcome-messages"},{"title":"Conversation Tags","href":"/en/documentation/inbox/conversation-tags"}]},{"group":"Analytics","pages":[{"title":"Conversation Logs","href":"/en/documentation/inbox/conversation-logs"},{"title":"Inbox Analytics","href":"/en/documentation/inbox/inbox-analytics"}]},{"group":"Best Practices","pages":[{"title":"Best Practices","href":"/en/documentation/inbox/best-practices/index"},{"title":"How Sales Teams Use Inbox","href":"/en/documentation/inbox/best-practices/how-sales-teams-use-inbox"},{"title":"How Service Teams Use Inbox","href":"/en/documentation/inbox/best-practices/how-service-teams-use-inbox"}]}]},{"group":"Contact","pages":[{"title":"Contact Management","href":"/en/documentation/contact/contact-management"},{"title":"Create/Import Contacts","href":"/en/documentation/contact/create-import-contacts"},{"title":"Contact Segments","href":"/en/documentation/contact/contact-segments"},{"title":"Contact Merge Rules","href":"/en/documentation/contact/contact-merge-rules"},{"title":"Bulk Operations","href":"/en/documentation/contact/bulk-operations"},{"title":"Unsubscribe List","href":"/en/documentation/contact/unsubscribe-list"},{"group":"Contact Settings","pages":[{"title":"Contact Settings","href":"/en/documentation/contact/contact-settings/index"},{"title":"Contact Attribute Settings","href":"/en/documentation/contact/contact-settings/contact-attribute-settings"},{"title":"Contact Tag Settings","href":"/en/documentation/contact/contact-settings/contact-tag-settings"},{"title":"Contact Event","href":"/en/documentation/contact/contact-settings/contact-event"}]},{"title":"Owner Assignment Settings (Agent/Sales Assignment)","href":"/en/documentation/contact/owner-assignment-settings-agent-sales-assignment"}]},{"group":"Calling","pages":[{"group":"Getting Started","pages":[{"title":"Overview","href":"/en/documentation/calling/overview"},{"title":"Quick start with Calling","href":"/en/documentation/calling/quick-start-with-calling"},{"title":"Admin Guide","href":"/en/documentation/calling/admin-guide"},{"title":"Agent Guide","href":"/en/documentation/calling/agent-guide"},{"title":"Outbound Calling Guide","href":"/en/documentation/calling/outbound-calling-guide"}]},{"title":"Recording and Transcription","href":"/en/documentation/calling/recording-and-transcription"},{"title":"Calling Logs","href":"/en/documentation/calling/calling-logs"}]},{"group":"Campaign","pages":[{"title":"Create a WhatsApp Marketing Campaign","href":"/en/documentation/campaign/create-a-whatsapp-marketing-campaign"},{"title":"Track button clicks","href":"/en/documentation/campaign/track-button-clicks"},{"title":"Analyze Campaign data","href":"/en/documentation/campaign/analyze-campaign-data"}]},{"group":"Journey","pages":[{"title":"Journey introduction","href":"/en/documentation/journey/journey-introduction"},{"title":"Create a journey","href":"/en/documentation/journey/create-a-journey"},{"group":"Components and Features Introduction","pages":[{"title":"Journey components","href":"/en/documentation/journey/components-and-features-introduction/index"},{"title":"Trigger","href":"/en/documentation/journey/components-and-features-introduction/trigger"},{"title":"Send template","href":"/en/documentation/journey/components-and-features-introduction/send-template"},{"title":"Message status rule","href":"/en/documentation/journey/components-and-features-introduction/message-status-rule"},{"title":"Add tag","href":"/en/documentation/journey/components-and-features-introduction/add-tag"},{"title":"Wait","href":"/en/documentation/journey/components-and-features-introduction/wait"},{"title":"Goal and Exit Rule","href":"/en/documentation/journey/components-and-features-introduction/goal-and-exit-rule"}]},{"title":"Journey best practices","href":"/en/documentation/journey/journey-best-practices"}]},{"group":"Agents","pages":[{"title":"Create an agent","href":"/en/documentation/agents/create-an-agent"},{"group":"AI Agent","pages":[{"title":"What is AI Agent","sidebarTitle":"What is AI Agent","href":"/en/documentation/agents/ai-agent/what-is-ai-agent"},{"title":"How to Create and Configure an AI Agent","sidebarTitle":"Create and Configure an AI Agent","href":"/en/documentation/agents/ai-agent/how-to-create-and-configure-an-ai-agent"},{"title":"AI Profile","sidebarTitle":"AI Profile","href":"/en/documentation/agents/ai-agent/ai-profile"},{"group":"AI Knowledge Base","pages":[{"title":"AI Knowledge Base","href":"/en/documentation/agents/ai-agent/ai-knowledge-base"},{"title":"Connect external app content","href":"/en/documentation/agents/ai-agent/connect-external-app-content"}]},{"title":"AI Skills","sidebarTitle":"AI Skills","href":"/en/documentation/agents/ai-agent/ai-skills"},{"title":"AI Recommendations","sidebarTitle":"AI Recommendations","href":"/en/documentation/agents/ai-agent/ai-recommendations"},{"title":"AI Performance","sidebarTitle":"AI Performance","href":"/en/documentation/agents/ai-agent/ai-performance"},{"title":"Best Practices for YCloud AI Agent","sidebarTitle":"YCloud AI Agent Best Practices","href":"/en/documentation/agents/ai-agent/best-practices/best-practices-for-ycloud-ai-agent"},{"title":"AI Guidance Best Practice","href":"/en/documentation/agents/ai-agent/best-practices/ai-guidance-best-practice"}]},{"group":"Rule-based Agent","pages":[{"title":"Rule-based Agent","href":"/en/documentation/agents/rule-based-agent/rule-based-agent"},{"title":"Create a Flow","href":"/en/documentation/agents/rule-based-agent/create-a-flow"},{"group":"Flow Components","pages":[{"title":"Rule-based Agent Flow Components","href":"/en/documentation/agents/rule-based-agent/flow-components/index"},{"title":"Trigger","href":"/en/documentation/agents/rule-based-agent/flow-components/trigger"},{"title":"Ask a Question","href":"/en/documentation/agents/rule-based-agent/flow-components/ask-a-question"},{"title":"Send Messages","href":"/en/documentation/agents/rule-based-agent/flow-components/send-messages"},{"title":"Agent Takeover","href":"/en/documentation/agents/rule-based-agent/flow-components/agent-takeover"},{"title":"Unsubscribe","href":"/en/documentation/agents/rule-based-agent/flow-components/unsubscribe"},{"title":"Branch","href":"/en/documentation/agents/rule-based-agent/flow-components/branch"},{"title":"Send Shopify orders","href":"/en/documentation/agents/rule-based-agent/flow-components/send-shopify-orders"}]},{"title":"Rule-based Agent Analytics","sidebarTitle":"Rule-based Agent Analytics","href":"/en/documentation/agents/rule-based-agent/rule-based-agent-analytics"},{"title":"Automatically Add Customers to Unsubscribe List","href":"/en/documentation/agents/rule-based-agent/best-practices/automatically-add-customers-to-unsubscribe-list"}]},{"title":"External Agent","href":"/en/documentation/agents/external-agent"},{"title":"Best Practices","href":"/en/documentation/agents/best-practices/index"}]},{"group":"CTWA (Click to WhatsApp Ad)","pages":[{"title":"CTWA Introduction","href":"/en/documentation/ctwa-click-to-whatsapp-ad/ctwa-introduction"},{"group":"Meta CTWA Ads","pages":[{"title":"Meta CTWA Ads","sidebarTitle":"Overview","icon":"meta","href":"/en/documentation/ctwa-click-to-whatsapp-ad/meta-ctwa-ads/index"},{"title":"Connect a Meta Ad Account","sidebarTitle":"Connect a Meta Ad Account","icon":"meta","href":"/en/documentation/ctwa-click-to-whatsapp-ad/meta-ctwa-ads/connect-a-meta-ad-account"},{"title":"Create a Click-to-WhatsApp Ad","sidebarTitle":"Create a Click-to-WhatsApp Ad","icon":"meta","href":"/en/documentation/ctwa-click-to-whatsapp-ad/meta-ctwa-ads/create-a-click-to-whatsapp-ad"},{"title":"Report CTWA Ad Results to Meta","icon":"meta","sidebarTitle":"Report Ad Results to Meta","href":"/en/documentation/ctwa-click-to-whatsapp-ad/meta-ctwa-ads/report-ctwa-ad-results-to-meta"}]},{"group":"TikTok Messaging Ad","pages":[{"title":"TikTok Messaging Ad","icon":"tiktok","href":"/en/documentation/ctwa-click-to-whatsapp-ad/tiktok-messaging-ad/index"},{"title":"Connect TikTok Ad Account","icon":"tiktok","href":"/en/documentation/ctwa-click-to-whatsapp-ad/tiktok-messaging-ad/connect-tiktok-ad-account"},{"title":"Create TikTok Instant Messaging Ad","icon":"tiktok","href":"/en/documentation/ctwa-click-to-whatsapp-ad/tiktok-messaging-ad/create-tiktok-instant-messaging-ad"},{"title":"Report Ad Results to TikTok","icon":"tiktok","sidebarTitle":"Report Ad Results to TikTok","href":"/en/documentation/ctwa-click-to-whatsapp-ad/tiktok-messaging-ad/report-ad-results-to-tiktok"}]},{"title":"Receive CTWA Visitors","href":"/en/documentation/ctwa-click-to-whatsapp-ad/receive-ctwa-visitors"},{"title":"CTWA Analysis","href":"/en/documentation/ctwa-click-to-whatsapp-ad/ctwa-analysis"}]},{"group":"Shop","pages":[{"title":"Shop Overview","href":"/en/documentation/shop/overview"},{"title":"Install Shop","href":"/en/documentation/shop/install-shop"},{"title":"Shipping Settings","href":"/en/documentation/shop/shipping-settings"},{"title":"Payment Settings","href":"/en/documentation/shop/payment-settings"},{"title":"Product","href":"/en/documentation/shop/product"},{"group":"Order","pages":[{"title":"Order","href":"/en/documentation/shop/orders/index"},{"title":"Shipping Import","href":"/en/documentation/shop/orders/shipping-import"}]}]},{"group":"WhatsApp pay","pages":[{"title":"Overview","href":"/en/documentation/whatsapp-pay/overview"},{"title":"Link Your Payment Account","href":"/en/documentation/whatsapp-pay/link-your-payment-account"},{"title":"Send order detail \u0026 checkout button message","href":"/en/documentation/whatsapp-pay/send-order-detail-and-checkout-button-message"},{"title":"Update order status","href":"/en/documentation/whatsapp-pay/update-order-status"}]},{"group":"Integrations","pages":[{"group":"Channels","pages":[{"title":"Channels","href":"/en/documentation/integrations/channels/index"},{"group":"Global SMS","pages":[{"title":"Global SMS","href":"/en/documentation/integrations/channels/global-sms/index"},{"title":"Getting Started","href":"/en/documentation/integrations/channels/global-sms/getting-started"},{"title":"SMS Basic Principles","href":"/en/documentation/integrations/channels/global-sms/sms-basic-principles"},{"group":"SMS Features","pages":[{"title":"SMS Features","href":"/en/documentation/integrations/channels/global-sms/sms-features/index"},{"title":"API Interface","href":"/en/documentation/integrations/channels/global-sms/sms-features/api-interface"},{"title":"SMPP","href":"/en/documentation/integrations/channels/global-sms/sms-features/smpp"},{"title":"Mass Messaging","href":"/en/documentation/integrations/channels/global-sms/sms-features/mass-messaging"},{"title":"Sender ID","href":"/en/documentation/integrations/channels/global-sms/sms-features/sender-id"}]}]},{"group":"Verify","pages":[{"title":"Verify","href":"/en/documentation/integrations/channels/verify/index"},{"title":"Getting Started","href":"/en/documentation/integrations/channels/verify/getting-started"},{"group":"Verification Features","pages":[{"title":"Verification Features","href":"/en/documentation/integrations/channels/verify/verification-features/index"},{"title":"Verification Message Templates","href":"/en/documentation/integrations/channels/verify/verification-features/verification-message-templates"},{"title":"Security Settings","href":"/en/documentation/integrations/channels/verify/verification-features/security-settings"},{"title":"Verification Analysis","href":"/en/documentation/integrations/channels/verify/verification-features/verification-analysis"},{"title":"Custom OTP","href":"/en/documentation/integrations/channels/verify/verification-features/custom-otp"}]},{"group":"Best Practices for Verification","pages":[{"title":"Best Practices for Verification","href":"/en/documentation/integrations/channels/verify/best-practices-for-verification/index"},{"title":"Best Practices","href":"/en/documentation/integrations/channels/verify/best-practices-for-verification/best-practices"},{"title":"Verification Channel Selection","href":"/en/documentation/integrations/channels/verify/best-practices-for-verification/verification-channel-selection"},{"title":"Verification via WhatsApp","href":"/en/documentation/integrations/channels/verify/best-practices-for-verification/verification-via-whatsapp"},{"title":"Preventing Fraud and Invalid Registrations","href":"/en/documentation/integrations/channels/verify/best-practices-for-verification/preventing-fraud-and-invalid-registrations"}]}]},{"group":"Email","pages":[{"title":"Email","href":"/en/documentation/integrations/channels/email/index"},{"title":"Getting Started","href":"/en/documentation/integrations/channels/email/getting-started"},{"title":"Basic Principles","href":"/en/documentation/integrations/channels/email/basic-principles"},{"group":"Email Features","pages":[{"title":"Email Features","href":"/en/documentation/integrations/channels/email/email-features/index"},{"title":"Domain Configuration","href":"/en/documentation/integrations/channels/email/email-features/domain-configuration"},{"title":"Send emails via API","href":"/en/documentation/integrations/channels/email/email-features/send-emails-via-api"},{"title":"Monitoring and Optimization","href":"/en/documentation/integrations/channels/email/email-features/monitoring-and-optimization"}]},{"group":"Best Practices for Email","pages":[{"title":"Best Practices for Email","href":"/en/documentation/integrations/channels/email/best-practices-for-email/index"},{"title":"Separate Marketing Subdomain","href":"/en/documentation/integrations/channels/email/best-practices-for-email/separate-marketing-subdomain"},{"title":"Warm-up Sending","href":"/en/documentation/integrations/channels/email/best-practices-for-email/warm-up-sending"}]},{"title":"Email Template Samples","href":"/en/documentation/integrations/channels/email/email-template-samples"}]}]},{"group":"Coupons","pages":[{"title":"Coupon Tool Usage","href":"/en/documentation/integrations/coupons/coupon-tool-usage"}]},{"group":"Shopify","pages":[{"title":"Connect your Shopify store","sidebarTitle":"Connect your Shopify store","icon":"shopify","href":"/en/documentation/integrations/e-commerce/shopify/index"},{"title":"Send Shopify products and manage orders in Inbox","sidebarTitle":"Shopify in Inbox","icon":"shopify","href":"/en/documentation/integrations/e-commerce/shopify/use-shopify-in-inbox"},{"group":"Automate Shopify notifications","pages":[{"title":"Recover abandoned checkouts","sidebarTitle":"Recover abandoned checkouts","href":"/en/documentation/integrations/e-commerce/shopify/recover-abandoned-checkouts"},{"title":"Confirm COD orders","sidebarTitle":"Confirm COD orders","href":"/en/documentation/integrations/e-commerce/shopify/confirm-cod-orders"},{"title":"Notify customers about canceled or fulfilled orders","sidebarTitle":"Notify customers about canceled or fulfilled orders","href":"/en/documentation/integrations/e-commerce/shopify/notify-customers-about-canceled-or-fulfilled-orders"}]},{"title":"Add a chat widget to your Shopify store","sidebarTitle":"Add a chat widget to your Shopify store","icon":"shopify","href":"/en/documentation/integrations/e-commerce/shopify/add-a-chat-widget-to-your-shopify-store"}]},{"title":"HubSpot","icon":"hubspot","href":"/en/documentation/integrations/hubspot"},{"title":"MM Lite API","href":"/en/documentation/integrations/mm-lite-api"},{"title":"Messenger marketing","href":"/en/documentation/integrations/messenger-marketing"},{"title":"Data connectors","href":"/en/documentation/integrations/data-connectors"},{"title":"Freshdesk","href":"/en/documentation/integrations/freshdesk"}]},{"group":"Developer","pages":[{"title":"Manage API keys","sidebarTitle":"API key management","href":"/en/documentation/developer/manage-api-keys"},{"title":"Configure an IP whitelist","sidebarTitle":"IP whitelist","href":"/en/documentation/developer/configure-an-ip-whitelist"},{"title":"Create and configure a custom app","href":"/en/documentation/developer/create-and-configure-a-custom-app"},{"title":"Webhooks","href":"/en/documentation/developer/webhooks"},{"group":"Integrate With n8n","pages":[{"title":"Integrate With n8n","href":"/en/documentation/developer/integrate-with-n8n/index"},{"title":"Best Practice: AI Auto-Reply","hidden":true,"href":"/en/documentation/developer/integrate-with-n8n/best-practice-ai-auto-reply"},{"title":"Example 1: AI auto-reply","hidden":true,"href":"/en/documentation/developer/integrate-with-n8n/example-1-ai-auto-reply"}]}]},{"group":"Account Management","pages":[{"title":"Company Info","sidebarTitle":"Company Info","href":"/en/documentation/account-management/company-info"},{"title":"Users and Teams","href":"/en/documentation/account-management/users-and-teams"},{"title":"Visual Agent","href":"/en/documentation/account-management/visual-agent"},{"title":"Personal Preferences Settings","href":"/en/documentation/account-management/personal-preferences-settings"},{"title":"Security and Privacy","href":"/en/documentation/account-management/security-and-privacy"},{"title":"Notification \u0026 Alert","href":"/en/documentation/account-management/notification-and-alert"}]},{"group":"Pricing and Billing","pages":[{"title":"Billing overview","href":"/en/documentation/pricing-and-billing/billing-overview"},{"title":"WhatsApp pricing and billing","href":"/en/documentation/pricing-and-billing/whatsapp-pricing-and-billing"},{"title":"Manage subscriptions and add-ons","href":"/en/documentation/pricing-and-billing/manage-subscriptions-and-add-ons"},{"title":"Billing and Recharge","href":"/en/documentation/pricing-and-billing/billing-and-recharge"},{"title":"Set up billing notifications","href":"/en/documentation/pricing-and-billing/set-up-billing-notifications"},{"title":"Invoices","href":"/en/documentation/pricing-and-billing/invoices"},{"title":"Payment methods and cards","href":"/en/documentation/pricing-and-billing/payment-methods-and-cards"}]},{"group":"Partnership","pages":[{"title":"Partner Documentation","href":"/en/documentation/partnership/partner-documentation"}]},{"group":"Support","pages":[{"title":"YCloud Support Team","href":"/en/documentation/support/ycloud-support-team"},{"title":"Meta Support","href":"/en/documentation/support/meta-support"},{"title":"Frequently Asked Questions","icon":"circle-question","href":"/en/documentation/support/frequently-asked-questions"}]}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Getting Started","pages":[{"title":"YCloud API","href":"/en/api-reference/getting-started/ycloud-api"},{"title":"Quickstart","href":"/en/api-reference/getting-started/quickstart"},{"title":"API changelog","href":"/en/api-reference/getting-started/changelog"}]},{"group":"Guides","pages":[{"title":"Guides","href":"/en/api-reference/guides/overview"},{"group":"API fundamentals","pages":[{"title":"Authentication","href":"/en/api-reference/guides/api-fundamentals/authentication"},{"title":"Handle errors","href":"/en/api-reference/guides/api-fundamentals/handle-errors"},{"title":"Rate limits","href":"/en/api-reference/guides/api-fundamentals/rate-limits"},{"title":"Pagination","href":"/en/api-reference/guides/api-fundamentals/pagination"},{"title":"API versioning and compatibility","href":"/en/api-reference/guides/api-fundamentals/versioning"},{"title":"Configure webhooks","href":"/en/api-reference/guides/api-fundamentals/configure-webhooks"},{"title":"Implement a webhook receiver","href":"/en/api-reference/guides/api-fundamentals/implement-a-webhook-receiver"}]},{"group":"WhatsApp platform","pages":[{"group":"Send and receive","pages":[{"title":"Send a WhatsApp message","href":"/en/api-reference/guides/whatsapp-platform/send-whatsapp-message"},{"title":"WhatsApp error code","href":"/en/api-reference/guides/whatsapp-platform/whatsapp-error-code"},{"title":"Handle WhatsApp inbound messages","href":"/en/api-reference/guides/whatsapp-platform/handle-whatsapp-inbound-messages"},{"title":"Upload WhatsApp media","href":"/en/api-reference/guides/whatsapp-platform/upload-whatsapp-media"},{"title":"WhatsApp Message Pricing Integration Guide","href":"/en/api-reference/guides/whatsapp-platform/whatsapp-message-pricing-integration-guide"},{"title":"Max Price Integration Guide","href":"/en/api-reference/guides/whatsapp-platform/max-price-integration-guide"}]},{"group":"Best practices","pages":[{"title":"WhatsApp Messages API best practices","href":"/en/api-reference/guides/whatsapp-platform/whatsapp-messages-api-best-practices"},{"title":"Direct Send best practices","href":"/en/api-reference/guides/whatsapp-platform/best-practices/direct-send"}]},{"group":"Business accounts","pages":[{"title":"Manage WhatsApp Business Accounts","href":"/en/api-reference/guides/whatsapp-platform/manage-whatsapp-business-accounts"},{"title":"Manage WhatsApp phone numbers","href":"/en/api-reference/guides/whatsapp-platform/manage-whatsapp-phone-numbers"},{"title":"Use business-scoped user IDs","href":"/en/api-reference/guides/whatsapp-platform/use-business-scoped-user-ids"}]},{"group":"Templates and flows","pages":[{"title":"Manage WhatsApp templates","href":"/en/api-reference/guides/whatsapp-platform/manage-whatsapp-templates"},{"title":"Supported WhatsApp template languages","href":"/en/api-reference/guides/whatsapp-platform/supported-whatsapp-template-languages"},{"title":"Manage WhatsApp Flows","href":"/en/api-reference/guides/whatsapp-platform/manage-whatsapp-flows"},{"title":"Implement a WhatsApp Flow endpoint","href":"/en/api-reference/guides/whatsapp-platform/implement-a-whatsapp-flow-endpoint"}]},{"group":"Calling and groups","pages":[{"title":"Manage WhatsApp calls","href":"/en/api-reference/guides/whatsapp-platform/manage-whatsapp-calls"},{"title":"Manage WhatsApp groups","href":"/en/api-reference/guides/whatsapp-platform/manage-whatsapp-groups"}]}]},{"group":"Meta Business Agent","pages":[{"title":"Meta Business Agent overview","href":"/en/documentation/meta-business-agent/overview"},{"title":"Prepare and check eligibility","href":"/en/documentation/meta-business-agent/prepare-and-check-eligibility"},{"title":"Onboard and configure","href":"/en/documentation/meta-business-agent/onboard-and-configure"},{"title":"Test and evaluate","href":"/en/documentation/meta-business-agent/test-and-evaluate"},{"title":"Roll out safely","href":"/en/documentation/meta-business-agent/roll-out-safely"},{"title":"Operate and troubleshoot","href":"/en/documentation/meta-business-agent/operate-and-troubleshoot"}]},{"group":"Customer data and operations","pages":[{"title":"Check account balance","href":"/en/api-reference/guides/customer-data-and-operations/check-account-balance"},{"title":"Manage contacts","href":"/en/api-reference/guides/customer-data-and-operations/manage-contacts"},{"title":"Track custom events","href":"/en/api-reference/guides/customer-data-and-operations/track-custom-events"},{"title":"Manage unsubscribers","href":"/en/api-reference/guides/customer-data-and-operations/manage-unsubscribers"}]},{"group":"Examples","pages":[{"title":"API and webhook examples","href":"/en/api-reference/guides/examples/overview"},{"group":"API examples","pages":[{"title":"WhatsApp Template Creation Examples","href":"/en/api-reference/guides/examples/api-examples/whatsapp-template-creation-examples"},{"title":"WhatsApp Messaging Examples","href":"/en/api-reference/guides/examples/api-examples/whatsapp-messaging-examples"}]},{"group":"Webhook examples","pages":[{"title":"Webhook examples","href":"/en/api-reference/guides/examples/webhook-examples/overview"},{"group":"Messages","pages":[{"title":"Message status webhook examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-message-updated-webhook-examples"},{"title":"Inbound message and preference webhook examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-inbound-message-webhook-examples"}]},{"group":"Meta Business Agent","pages":[{"title":"Meta Business Agent echo message created","sidebarTitle":"Echo message created","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created"},{"title":"Meta Business Agent echo message updated","sidebarTitle":"Echo message updated","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-updated"},{"title":"Meta Business Agent control handover","sidebarTitle":"Control handover","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-meta-business-agent-handover-updated"}]},{"group":"WhatsApp Business App","pages":[{"title":"WhatsApp Business App History Message Webhook Examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-business-app-history-message-webhook-examples"},{"title":"WhatsApp Business App Sent Message Sync Webhook Examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-business-app-sent-message-sync-webhook-examples"}]},{"group":"Templates and accounts","pages":[{"title":"WhatsApp template webhook examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-template-reviewed-webhook-examples"},{"title":"WhatsApp account and phone number webhook examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-business-account-updated-webhook-examples"}]},{"group":"Calling","pages":[{"title":"WhatsApp Calling Connect Webhook Examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-calling-connect-webhook-examples"},{"title":"WhatsApp Calling Status Update Webhook Examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-calling-status-update-webhook-examples"},{"title":"WhatsApp call termination and capture webhook examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-calling-terminate-webhook-examples"}]},{"group":"Groups","pages":[{"title":"WhatsApp Group Lifecycle Update Webhook Examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-group-lifecycle-update-webhook-examples"},{"title":"WhatsApp Group Participants Update Webhook Examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-group-participants-update-webhook-examples"},{"title":"WhatsApp Group Settings Update Webhook Examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-group-settings-update-webhook-examples"},{"title":"WhatsApp Group Status Update Webhook Examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-group-status-update-webhook-examples"}]},{"group":"Flows","pages":[{"title":"WhatsApp Flow Webhook Examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-flow-webhook-examples"}]},{"group":"Payments","pages":[{"title":"WhatsApp Payment Updated Webhook Examples","href":"/en/api-reference/guides/examples/webhook-examples/whatsapp-payment-updated-webhook-examples"}]},{"group":"Contacts and opt-outs","pages":[{"title":"Contact and note creation webhook examples","href":"/en/api-reference/guides/examples/webhook-examples/contact-created-webhook-examples"},{"title":"Contact and note deletion webhook examples","href":"/en/api-reference/guides/examples/webhook-examples/contact-deleted-webhook-examples"},{"title":"Contact and note update webhook examples","href":"/en/api-reference/guides/examples/webhook-examples/contact-attributes-changed-webhook-examples"},{"title":"Contact Unsubscribe Created Webhook Examples","href":"/en/api-reference/guides/examples/webhook-examples/contact-unsubscribe-created-webhook-examples"},{"title":"Contact Unsubscribe Deleted Webhook Examples","href":"/en/api-reference/guides/examples/webhook-examples/contact-unsubscribe-deleted-webhook-examples"}]},{"title":"Webhook payload examples","href":"/en/api-reference/guides/examples/webhook-examples/webhook-payload-examples"}]}]}]},{"group":"Endpoints","pages":[{"group":"WhatsApp Business Accounts","pages":[{"title":"List WABAs","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/businessAccounts","href":"/api-reference/whatsapp-business-accounts/list-wabas"},{"title":"Retrieve a WABA","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/businessAccounts/{id}","href":"/api-reference/whatsapp-business-accounts/retrieve-a-waba"},{"title":"Retrieve WABA automatic creative optimizations","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/businessAccounts/{wabaId}/automatic-creative-optimizations","href":"/api-reference/whatsapp-business-accounts/retrieve-waba-automatic-creative-optimizations"},{"title":"Update WABA automatic creative optimizations","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/businessAccounts/{wabaId}/automatic-creative-optimizations","href":"/api-reference/whatsapp-business-accounts/update-waba-automatic-creative-optimizations"}]},{"group":"WhatsApp Inbound Messages","pages":[{"title":"Mark message as read","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/inboundMessages/{id}/markAsRead","href":"/api-reference/whatsapp-inbound-messages/mark-message-as-read"},{"title":"Mark message as read and display a typing indicator with a JSON response","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/inboundMessages/{id}/typing","href":"/api-reference/whatsapp-inbound-messages/mark-message-as-read-and-display-a-typing-indicator-with-a-json-response"}]},{"group":"WhatsApp Media","pages":[{"title":"Upload media","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/media/{phoneNumber}/upload","href":"/api-reference/whatsapp-media/upload-media"}]},{"group":"WhatsApp Messages","pages":[{"title":"Send a message directly","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/messages/sendDirectly","href":"/api-reference/whatsapp-messages/send-a-message-directly"},{"title":"Enqueue a message","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/messages","href":"/api-reference/whatsapp-messages/enqueue-a-message"},{"title":"Retrieve a message","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/messages/{id}","href":"/api-reference/whatsapp-messages/retrieve-a-message"},{"title":"Submit a Direct Send message sample","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/messages/{wabaId}/messageSamples","href":"/api-reference/whatsapp-messages/submit-a-direct-send-message-sample"}]},{"group":"Messenger Messages","pages":[{"title":"Send a Messenger text reply directly","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /messenger/messages/sendDirectly","href":"/api-reference/messenger-messages/send-a-messenger-text-reply-directly"},{"title":"Retrieve an outbound message by its YCloud ID","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /messenger/messages/{id}","href":"/api-reference/messenger-messages/retrieve-an-outbound-message-by-its-ycloud-id"},{"title":"Retrieve an outbound message by its Meta message ID","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /messenger/messages/retrieveByMetaMessageId","href":"/api-reference/messenger-messages/retrieve-an-outbound-message-by-its-meta-message-id"}]},{"group":"WhatsApp Blocked Users","pages":[{"title":"Block users","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/{businessPhoneNumber}/blockUsers","href":"/api-reference/whatsapp-blocked-users/block-users"},{"title":"Unblock users","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/{businessPhoneNumber}/unblockUsers","href":"/api-reference/whatsapp-blocked-users/unblock-users"},{"title":"List blocked users","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/{businessPhoneNumber}/blockedUsers","href":"/api-reference/whatsapp-blocked-users/list-blocked-users"}]},{"group":"WhatsApp Groups","pages":[{"title":"Create a group","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/{businessPhoneNumber}/groups","href":"/api-reference/whatsapp-groups/create-a-group"},{"title":"List groups","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/{businessPhoneNumber}/groups","href":"/api-reference/whatsapp-groups/list-groups"},{"title":"Retrieve a group","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/{businessPhoneNumber}/groups/{groupId}","href":"/api-reference/whatsapp-groups/retrieve-a-group"},{"title":"Delete a group","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/{businessPhoneNumber}/groups/{groupId}","href":"/api-reference/whatsapp-groups/delete-a-group"},{"title":"Retrieve a group invite link","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/{businessPhoneNumber}/groups/{groupId}/inviteLink","href":"/api-reference/whatsapp-groups/retrieve-a-group-invite-link"},{"title":"Reset a group invite link","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/{businessPhoneNumber}/groups/{groupId}/inviteLink/reset","href":"/api-reference/whatsapp-groups/reset-a-group-invite-link"},{"title":"Send a group invite link message","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/{businessPhoneNumber}/groups/inviteLink/messages","href":"/api-reference/whatsapp-groups/send-a-group-invite-link-message"},{"title":"List group join requests","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/{businessPhoneNumber}/groups/{groupId}/joinRequests","href":"/api-reference/whatsapp-groups/list-group-join-requests"},{"title":"Approve group join requests","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/{businessPhoneNumber}/groups/{groupId}/joinRequests/approve","href":"/api-reference/whatsapp-groups/approve-group-join-requests"},{"title":"Reject group join requests","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/{businessPhoneNumber}/groups/{groupId}/joinRequests/reject","href":"/api-reference/whatsapp-groups/reject-group-join-requests"},{"title":"Remove group participants","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/groups/{groupId}/participants/remove","href":"/api-reference/whatsapp-groups/remove-group-participants"},{"title":"Update group settings","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/{businessPhoneNumber}/groups/{groupId}/settings","href":"/api-reference/whatsapp-groups/update-group-settings"}]},{"group":"WhatsApp Calling","pages":[{"title":"Connect a call","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/calls/connect","href":"/api-reference/whatsapp-calling/connect-a-call"},{"title":"Pre-accept a call","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/calls/preAccept","href":"/api-reference/whatsapp-calling/pre-accept-a-call"},{"title":"Accept a call","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/calls/accept","href":"/api-reference/whatsapp-calling/accept-a-call"},{"title":"Terminate a call","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/calls/terminate","href":"/api-reference/whatsapp-calling/terminate-a-call"},{"title":"Reject a call","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/calls/reject","href":"/api-reference/whatsapp-calling/reject-a-call"},{"title":"Download call media","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/calls/media/{mediaAssetId}","href":"/api-reference/whatsapp-calling/download-call-media"}]},{"group":"WhatsApp Phone Numbers","pages":[{"title":"List phone numbers","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/phoneNumbers","href":"/api-reference/whatsapp-phone-numbers/list-phone-numbers"},{"title":"Retrieve a phone number","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}","href":"/api-reference/whatsapp-phone-numbers/retrieve-a-phone-number"},{"title":"Retrieve a phone number profile","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/profile","href":"/api-reference/whatsapp-phone-numbers/retrieve-a-phone-number-profile"},{"title":"Update a phone number profile","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/profile","href":"/api-reference/whatsapp-phone-numbers/update-a-phone-number-profile"},{"title":"Update a phone number display name","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/displayName","href":"/api-reference/whatsapp-phone-numbers/update-a-phone-number-display-name"},{"title":"Retrieve commerce settings","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/whatsappCommerceSettings","href":"/api-reference/whatsapp-phone-numbers/retrieve-commerce-settings"},{"title":"Update commerce settings","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/whatsappCommerceSettings","href":"/api-reference/whatsapp-phone-numbers/update-commerce-settings"},{"title":"Register a phone number","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/register","href":"/api-reference/whatsapp-phone-numbers/register-a-phone-number"},{"title":"Retrieve phone number settings","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/settings","href":"/api-reference/whatsapp-phone-numbers/retrieve-phone-number-settings"},{"title":"Save phone number settings","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/settings","href":"/api-reference/whatsapp-phone-numbers/save-phone-number-settings"},{"title":"Retrieve a phone number business username","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/businessUsername","href":"/api-reference/whatsapp-phone-numbers/retrieve-a-phone-number-business-username"},{"title":"Retrieve phone number business username suggestions","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/businessUsername/suggestions","href":"/api-reference/whatsapp-phone-numbers/retrieve-phone-number-business-username-suggestions"},{"title":"Update a phone number business username","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/businessUsername","href":"/api-reference/whatsapp-phone-numbers/update-a-phone-number-business-username"},{"title":"Delete a phone number business username","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/businessUsername","href":"/api-reference/whatsapp-phone-numbers/delete-a-phone-number-business-username"},{"title":"Delete a Meta contact book entry","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/contactBook/{bsuid}","href":"/api-reference/whatsapp-phone-numbers/delete-a-meta-contact-book-entry"}]},{"group":"WhatsApp Templates","pages":[{"title":"Create a template","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/templates","href":"/api-reference/whatsapp-templates/create-a-template"},{"title":"List templates","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/templates","href":"/api-reference/whatsapp-templates/list-templates"},{"title":"Retrieve WhatsApp template analytics","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/templates/analytics","href":"/api-reference/whatsapp-templates/retrieve-whatsapp-template-analytics"},{"title":"Delete templates by name","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/templates/{wabaId}/{name}","href":"/api-reference/whatsapp-templates/delete-templates-by-name"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/templates/{wabaId}/{name}/{language}","href":"/api-reference/whatsapp-templates/delete-a-template"},{"title":"Edit a template","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/templates/{wabaId}/{name}/{language}","href":"/api-reference/whatsapp-templates/edit-a-template"},{"title":"Retrieve a template","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/templates/{wabaId}/{name}/{language}","href":"/api-reference/whatsapp-templates/retrieve-a-template"}]},{"group":"WhatsApp Flows","pages":[{"title":"Create a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/flows","href":"/api-reference/whatsapp-flows/create-a-flow"},{"title":"List flows","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/flows","href":"/api-reference/whatsapp-flows/list-flows"},{"title":"Update flow metadata","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/flows/{flowId}/metadata","href":"/api-reference/whatsapp-flows/update-flow-metadata"},{"title":"Update flow structure","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/flows/{flowId}/assets","href":"/api-reference/whatsapp-flows/update-flow-structure"},{"title":"Delete a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/flows/{flowId}","href":"/api-reference/whatsapp-flows/delete-a-flow"},{"title":"Retrieve a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/flows/{flowId}","href":"/api-reference/whatsapp-flows/retrieve-a-flow"},{"title":"Publish a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/flows/{flowId}/publish","href":"/api-reference/whatsapp-flows/publish-a-flow"},{"title":"Deprecate a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/flows/{flowId}/deprecate","href":"/api-reference/whatsapp-flows/deprecate-a-flow"},{"title":"generate a web preview URL with this flow.","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/flows/{flowId}/preview","href":"/api-reference/whatsapp-flows/generate-a-web-preview-url-with-this-flow"}]},{"group":"Balance","pages":[{"title":"Retrieve balance","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /balance","href":"/api-reference/balance/retrieve-balance"}]},{"group":"Contacts","pages":[{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /contact/contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"List contacts","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /contact/contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Retrieve a contact","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /contact/contacts/{id}","href":"/api-reference/contacts/retrieve-a-contact"},{"title":"List contact notes","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /contact/contacts/{contactIdentifier}/notes","href":"/api-reference/contacts/list-contact-notes"},{"title":"Create a contact note","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /contact/contacts/{contactIdentifier}/notes","href":"/api-reference/contacts/create-a-contact-note"},{"title":"Update a contact note","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /contact/notes/{noteId}","href":"/api-reference/contacts/update-a-contact-note"},{"title":"Delete a contact note","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /contact/notes/{noteId}","href":"/api-reference/contacts/delete-a-contact-note"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /contact/contacts/{id}","href":"/api-reference/contacts/update-a-contact"},{"title":"Delete a contact","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /contact/contacts/{id}","href":"/api-reference/contacts/delete-a-contact"},{"title":"List contact attributes","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /contact/contacts/attributes","href":"/api-reference/contacts/list-contact-attributes"}]},{"group":"Custom Events","pages":[{"title":"Create an event definition","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /event/definitions","href":"/api-reference/custom-events/create-an-event-definition"},{"title":"Retrieve an event definition","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /event/definitions/{name}","href":"/api-reference/custom-events/retrieve-an-event-definition"},{"title":"Update an event definition","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /event/definitions/{name}","href":"/api-reference/custom-events/update-an-event-definition"},{"title":"Create an event property definition","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /event/definitions/{name}/properties","href":"/api-reference/custom-events/create-an-event-property-definition"},{"title":"Update an event property definition","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /event/definitions/{name}/properties/{propertyName}","href":"/api-reference/custom-events/update-an-event-property-definition"},{"title":"Delete an event property definition","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /event/definitions/{name}/properties/{propertyName}","href":"/api-reference/custom-events/delete-an-event-property-definition"},{"title":"Send an event","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /event/events","href":"/api-reference/custom-events/send-an-event"}]},{"group":"Emails","pages":[{"title":"Send an email","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /emails","href":"/api-reference/emails/send-an-email"}]},{"group":"SMS","pages":[{"title":"Send an SMS","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /sms","href":"/api-reference/sms/send-an-sms"},{"title":"List SMS records","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /sms","href":"/api-reference/sms/list-sms-records"}]},{"group":"Unsubscribers","pages":[{"title":"Create an unsubscriber","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /unsubscribers","href":"/api-reference/unsubscribers/create-an-unsubscriber"},{"title":"List unsubscribers","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /unsubscribers","href":"/api-reference/unsubscribers/list-unsubscribers"},{"title":"List all unsubscribers by customer","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /unsubscribers/{customer}","href":"/api-reference/unsubscribers/list-all-unsubscribers-by-customer"},{"title":"Retrieve an unsubscriber","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /unsubscribers/{customer}/{channel}","href":"/api-reference/unsubscribers/retrieve-an-unsubscriber"},{"title":"Delete an unsubscriber","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /unsubscribers/{customer}/{channel}","href":"/api-reference/unsubscribers/delete-an-unsubscriber"}]},{"group":"Verify","pages":[{"title":"Start a verification","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /verify/verifications","href":"/api-reference/verify/start-a-verification"},{"title":"Check a verification","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /verify/verificationChecks","href":"/api-reference/verify/check-a-verification"}]},{"group":"Voices","pages":[{"title":"Send a voice code","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /voices","href":"/api-reference/voices/send-a-voice-code"},{"title":"List voice records","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /voices","href":"/api-reference/voices/list-voice-records"}]},{"group":"Webhook Endpoints","pages":[{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /webhookEndpoints","href":"/api-reference/webhook-endpoints/create-a-webhook-endpoint"},{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /webhookEndpoints","href":"/api-reference/webhook-endpoints/list-webhook-endpoints"},{"title":"Retrieve a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /webhookEndpoints/{id}","href":"/api-reference/webhook-endpoints/retrieve-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /webhookEndpoints/{id}","href":"/api-reference/webhook-endpoints/update-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /webhookEndpoints/{id}","href":"/api-reference/webhook-endpoints/delete-a-webhook-endpoint"},{"title":"Rotate a webhook endpoint secret","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /webhookEndpoints/{id}/rotateSecret","href":"/api-reference/webhook-endpoints/rotate-a-webhook-endpoint-secret"}]},{"group":"Meta Business Agent","pages":[{"title":"Meta Business Agent overview","href":"/en/api-reference/meta-business-agents/overview"},{"group":"Configure","pages":[{"group":"Agent Knowledge - Business Info","pages":[{"title":"Get Business Info","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/businessInfo","href":"/api-reference/meta-business-agents/get-business-info"},{"title":"Replace Business Info","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json put /metaBusinessAgents/{entityId}/businessInfo","href":"/api-reference/meta-business-agents/replace-business-info"},{"title":"Delete Business Info","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json delete /metaBusinessAgents/{entityId}/businessInfo","href":"/api-reference/meta-business-agents/delete-business-info"}]},{"group":"Agent Knowledge - FAQs","pages":[{"title":"List Faqs","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/faqs","href":"/api-reference/meta-business-agents/list-faqs"},{"title":"Create Faq","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/faqs","href":"/api-reference/meta-business-agents/create-faq"},{"title":"Get Faq","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/faqs/{faqId}","href":"/api-reference/meta-business-agents/get-faq"},{"title":"Update Faq","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json patch /metaBusinessAgents/{entityId}/faqs/{faqId}","href":"/api-reference/meta-business-agents/update-faq"},{"title":"Delete Faq","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json delete /metaBusinessAgents/{entityId}/faqs/{faqId}","href":"/api-reference/meta-business-agents/delete-faq"}]},{"group":"Agent Knowledge - Files","pages":[{"title":"List Files","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/files","href":"/api-reference/meta-business-agents/list-files"},{"title":"Upload File","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/files","href":"/api-reference/meta-business-agents/upload-file"},{"title":"Get File","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/files/{fileId}","href":"/api-reference/meta-business-agents/get-file"},{"title":"Delete File","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json delete /metaBusinessAgents/{entityId}/files/{fileId}","href":"/api-reference/meta-business-agents/delete-file"}]},{"group":"Agent Knowledge - Websites","pages":[{"title":"List Websites","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/websites","href":"/api-reference/meta-business-agents/list-websites"},{"title":"Create Website","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/websites","href":"/api-reference/meta-business-agents/create-website"},{"title":"Get Website","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/websites/{websiteId}","href":"/api-reference/meta-business-agents/get-website"},{"title":"Update Website","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json patch /metaBusinessAgents/{entityId}/websites/{websiteId}","href":"/api-reference/meta-business-agents/update-website"},{"title":"Delete Website","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json delete /metaBusinessAgents/{entityId}/websites/{websiteId}","href":"/api-reference/meta-business-agents/delete-website"}]},{"group":"Agent Skills","pages":[{"title":"List Skills","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/skills","href":"/api-reference/meta-business-agents/list-skills"},{"title":"Create Skill","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/skills","href":"/api-reference/meta-business-agents/create-skill"},{"title":"Get Skill","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/skills/{skillId}","href":"/api-reference/meta-business-agents/get-skill"},{"title":"Update Skill","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json patch /metaBusinessAgents/{entityId}/skills/{skillId}","href":"/api-reference/meta-business-agents/update-skill"},{"title":"Delete Skill","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json delete /metaBusinessAgents/{entityId}/skills/{skillId}","href":"/api-reference/meta-business-agents/delete-skill"}]},{"group":"UI Skills","pages":[{"title":"List UI Skills","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/uiSkills","href":"/api-reference/meta-business-agents/list-ui-skills"},{"title":"Create UI Skill","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/uiSkills","href":"/api-reference/meta-business-agents/create-ui-skill"},{"title":"Get UI Skill","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/uiSkills/{skillId}","href":"/api-reference/meta-business-agents/get-ui-skill"},{"title":"Update UI Skill","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json patch /metaBusinessAgents/{entityId}/uiSkills/{skillId}","href":"/api-reference/meta-business-agents/update-ui-skill"},{"title":"Delete UI Skill","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json delete /metaBusinessAgents/{entityId}/uiSkills/{skillId}","href":"/api-reference/meta-business-agents/delete-ui-skill"}]},{"group":"Connector Tools","pages":[{"title":"List Connector Tools","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/connectors/{connectorId}/tools","href":"/api-reference/meta-business-agents/list-connector-tools"},{"title":"Create Connector Tool","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/connectors/{connectorId}/tools","href":"/api-reference/meta-business-agents/create-connector-tool"},{"title":"Get Connector Tool","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/connectors/{connectorId}/tools/{toolId}","href":"/api-reference/meta-business-agents/get-connector-tool"},{"title":"Update Connector Tool","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json patch /metaBusinessAgents/{entityId}/connectors/{connectorId}/tools/{toolId}","href":"/api-reference/meta-business-agents/update-connector-tool"},{"title":"Delete Connector Tool","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json delete /metaBusinessAgents/{entityId}/connectors/{connectorId}/tools/{toolId}","href":"/api-reference/meta-business-agents/delete-connector-tool"},{"title":"Run Connector Tool","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/connectors/{connectorId}/tools/{toolId}/runs","href":"/api-reference/meta-business-agents/run-connector-tool"}]},{"group":"Connectors","pages":[{"title":"List Connectors","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/connectors","href":"/api-reference/meta-business-agents/list-connectors"},{"title":"Create Connector","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/connectors","href":"/api-reference/meta-business-agents/create-connector"},{"title":"Get Connector","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/connectors/{connectorId}","href":"/api-reference/meta-business-agents/get-connector"},{"title":"Update Connector","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json patch /metaBusinessAgents/{entityId}/connectors/{connectorId}","href":"/api-reference/meta-business-agents/update-connector"},{"title":"Refresh MCP Connector Tools","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/connectors/{connectorId}/refreshMCPTools","href":"/api-reference/meta-business-agents/refresh-mcp-connector-tools"},{"title":"Delete Connector","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json delete /metaBusinessAgents/{entityId}/connectors/{connectorId}","href":"/api-reference/meta-business-agents/delete-connector"},{"title":"Upsert Connector Certificate","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json put /metaBusinessAgents/{entityId}/connectors/{connectorId}/credentials/certificate","href":"/api-reference/meta-business-agents/upsert-connector-certificate"},{"title":"Upsert Connector Api Key","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json put /metaBusinessAgents/{entityId}/connectors/{connectorId}/credentials/apiKey","href":"/api-reference/meta-business-agents/upsert-connector-api-key"},{"title":"Upsert Connector O Auth","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json put /metaBusinessAgents/{entityId}/connectors/{connectorId}/credentials/oauth","href":"/api-reference/meta-business-agents/upsert-connector-o-auth"},{"title":"List Connector Logs","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/connectors/{connectorId}/logs","href":"/api-reference/meta-business-agents/list-connector-logs"}]}]},{"group":"Delete Agent","pages":[{"title":"Delete Agent","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json delete /metaBusinessAgents/{entityId}","href":"/api-reference/meta-business-agents/delete-agent"}]},{"group":"Onboard","pages":[{"group":"Agent Allowlist","pages":[{"title":"List Allowlist","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/allowListEntries","href":"/api-reference/meta-business-agents/list-allowlist"},{"title":"Create Allowlist Entry","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/allowListEntries","href":"/api-reference/meta-business-agents/create-allowlist-entry"},{"title":"Delete Allowlist Entry","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json delete /metaBusinessAgents/{entityId}/allowListEntries/{entryId}","href":"/api-reference/meta-business-agents/delete-allowlist-entry"}]},{"group":"Agent Eligibility","pages":[{"title":"Check Eligibility","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/eligibility","href":"/api-reference/meta-business-agents/check-eligibility"}]},{"group":"Agent Onboarding","pages":[{"title":"Onboard Agent","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/onboarding","href":"/api-reference/meta-business-agents/onboard-agent"}]},{"group":"Agent Settings","pages":[{"title":"Get Settings","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/settings","href":"/api-reference/meta-business-agents/get-settings"},{"title":"Replace Settings","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json put /metaBusinessAgents/{entityId}/settings","href":"/api-reference/meta-business-agents/replace-settings"}]},{"group":"Agent Budgets","pages":[{"title":"Get Budgets","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/budgets","href":"/api-reference/meta-business-agents/get-budgets"},{"title":"Replace Budgets","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json put /metaBusinessAgents/{entityId}/budgets","href":"/api-reference/meta-business-agents/replace-budgets"}]}]},{"group":"Operate","pages":[{"group":"Agent Eval","pages":[{"title":"List Eval Cases","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/evalCases","href":"/api-reference/meta-business-agents/list-eval-cases"},{"title":"Get Eval Summary","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/evalSummaries","href":"/api-reference/meta-business-agents/get-eval-summary"},{"title":"Get Eval Details","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/evals","href":"/api-reference/meta-business-agents/get-eval-details"},{"title":"Get Eval Run Status","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/evalRuns/{jobId}","href":"/api-reference/meta-business-agents/get-eval-run-status"},{"title":"Submit Eval Run","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/evalRuns","href":"/api-reference/meta-business-agents/submit-eval-run"}]},{"group":"Agent Event","pages":[{"title":"Submit Agent Event","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/events","href":"/api-reference/meta-business-agents/submit-agent-event"},{"title":"Get Agent Event Status","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/events/{agentEventId}","href":"/api-reference/meta-business-agents/get-agent-event-status"}]},{"group":"Agent Test","pages":[{"title":"Test Agent","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/tests","href":"/api-reference/meta-business-agents/test-agent"}]},{"group":"Conversation Turns","pages":[{"title":"Get Conversation Turns","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/conversationTurns","href":"/api-reference/meta-business-agents/get-conversation-turns"}]},{"group":"Thread Control (Cloud API)","pages":[{"title":"Control Thread","deprecated":null,"version":null,"openapi":"/openapi/endpoints/meta-business-agent-public.openapi.json post /metaBusinessAgents/{entityId}/threadControl","href":"/api-reference/meta-business-agents/control-thread"}]}]}]}]},{"group":"Webhooks","pages":[{"title":"Test webhooks","sidebarTitle":"Test webhooks","openapi":"openapi/webhooks/testing-webhooks.yaml POST /webhooks/ycloud","playground":"interactive","href":"/en/api-reference/webhooks/test-webhooks"}]}]},{"tab":"Partner Center","icon":"handshake","groups":[{"group":"Overview","icon":"compass","pages":[{"title":"YCloud Partner Documentation","href":"/en/partner-center/overview"}]},{"group":"Technical development partners","icon":"code","pages":[{"title":"Technical Development Partner Onboarding","href":"/en/partner-center/technical-development-partners/technical-development-partner-onboarding"},{"title":"Embedded signup","href":"/en/partner-center/technical-development-partners/embedded-signup"},{"title":"Partner Direct Link (TP Lite)","href":"/en/partner-center/technical-development-partners/partner-direct-link-tp-lite"},{"title":"Template Synchronisation","href":"/en/partner-center/technical-development-partners/template-synchronisation"},{"title":"Pricing, Billing, and Payment Methods for Technical Development Partners","href":"/en/partner-center/technical-development-partners/pricing-billing-and-payment-methods-for-technical-development-partners"},{"title":"Manage customer WABAs and phone numbers","href":"/en/partner-center/technical-development-partners/managing-customers-waba-and-numbers"}]},{"group":"Solution partners","icon":"briefcase","pages":[{"title":"Getting Started with Solution Partners","href":"/en/partner-center/solution-partners/getting-started-with-solution-partners"}]},{"group":"Affiliate partners","icon":"link","pages":[{"title":"Getting Started with Affiliate Partners","href":"/en/partner-center/affiliate-partners/getting-started-with-affiliate-partners"},{"title":"How do alliance partners receive payments?","href":"/en/partner-center/affiliate-partners/how-do-alliance-partners-receive-payments"}]}]}]},{"language":"zh","pages":[{"title":"zh","href":"/zh/documentation/overview"}]},{"language":"es","pages":[{"title":"es","href":"/es/documentation/overview"}]},{"language":"pt","pages":[{"title":"pt","href":"/pt/documentation/overview"}]},{"language":"ru","pages":[{"title":"ru","href":"/ru/documentation/overview"}]}]},"title":"操作概览 - YCloud Docs","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":[],"chunks":[]}