{"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":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/whatsapp-templates/list-templates","slug":"/api-reference/whatsapp-templates/list-templates","pageMetadata":{"title":"List templates","description":"Returns a paginated list of WhatsApp templates you've previously created.\n\nArchived templates are included when they match the query. Use `filter.status=ARCHIVED` to list archived templates explicitly.","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/templates","href":"/api-reference/whatsapp-templates/list-templates","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Returns a paginated list of WhatsApp templates you’ve previously created.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Archived templates are included when they match the query. Use \", _jsx(_components.code, {\n children: \"filter.status=ARCHIVED\"\n }), \" to list archived templates explicitly.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"title":"List templates","description":"Returns a paginated list of WhatsApp templates you've previously created.\n\nArchived templates are included when they match the query. Use `filter.status=ARCHIVED` to list archived templates explicitly.","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/templates","href":"/api-reference/whatsapp-templates/list-templates","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"List templates","operationId":"whatsapp_template-list","tags":["WhatsApp Templates"],"description":"Returns a paginated list of WhatsApp templates you've previously created.\n\nArchived templates are included when they match the query. Use `filter.status=ARCHIVED` to list archived templates explicitly.","x-group-parameters":true,"parameters":["28eb6a59-4c76-414d-a31b-a1fe1fa403e5","edab0d7e-0254-43fd-96a5-520f9110f100","dfa4c2b2-53d0-4f80-bcd1-ce39f9156112","d3386cfa-cbf7-471f-9181-1f236eca34b9","901188e6-8d44-42c4-a68f-4757de70ef19","85fc02b3-7e54-497c-9865-32bb0be12340","b7467d83-e984-43bf-bb97-9b2263fef791"],"responses":{"200":"6edb7bec-6380-42b2-b284-db848e716c79"},"method":"get","type":"path","servers":["e1a7c0ed-75fc-4496-9a27-11224882ca56"],"security":["b10e61f5-7bed-4fad-8aee-6f7090632636"],"path":"/whatsapp/templates","baseUrlOptions":["https://api.ycloud.com/v2"],"title":"List templates","codeSamples":[],"requiredOnlyExamples":true,"disableCodeSampleGeneration":true,"responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[],"urlDisplay":"full"},"dependencies":{"parameters":{"28eb6a59-4c76-414d-a31b-a1fe1fa403e5":{"name":"page","in":"query","description":"Page number of the results to be returned, 1-based.","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":1,"isRequired":false,"description":"Page number of the results to be returned, 1-based.","uniqueKey":"","typeLabel":"integer\u003cint32>"}},"edab0d7e-0254-43fd-96a5-520f9110f100":{"name":"limit","in":"query","description":"A limit on the number of results to be returned, or number of results per page, between 1 and 100, defaults to 10.","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":10,"isRequired":false,"description":"A limit on the number of results to be returned, or number of results per page, between 1 and 100, defaults to 10.","uniqueKey":"","typeLabel":"integer\u003cint32>"}},"dfa4c2b2-53d0-4f80-bcd1-ce39f9156112":{"name":"includeTotal","in":"query","description":"Return results inside an object that contains the total result count or not.","required":false,"schema":{"type":"boolean","default":false,"isRequired":false,"description":"Return results inside an object that contains the total result count or not.","uniqueKey":"","typeLabel":"boolean"}},"d3386cfa-cbf7-471f-9181-1f236eca34b9":{"name":"filter.wabaId","in":"query","description":"**Required if you have more than 100 WABAs.**\nWhatsApp Business Account ID.","required":false,"schema":{"type":"string","example":"whatsapp-business-account-id","isRequired":false,"description":"**Required if you have more than 100 WABAs.**\nWhatsApp Business Account ID.","uniqueKey":"","typeLabel":"string"}},"901188e6-8d44-42c4-a68f-4757de70ef19":{"name":"filter.name","in":"query","description":"Name of the template.","required":false,"schema":{"type":"string","maxLength":512,"pattern":"[a-z0-9]{1,512}","example":"sample_whatsapp_template","isRequired":false,"description":"Name of the template.","uniqueKey":"","typeLabel":"string"}},"85fc02b3-7e54-497c-9865-32bb0be12340":{"name":"filter.language","in":"query","description":"Language code of the template. See [Supported Languages](https://developers.facebook.com/documentation/business-messaging/whatsapp/templates/supported-languages) for all codes.","required":false,"schema":{"type":"string","example":"en","isRequired":false,"description":"Language code of the template. See [Supported Languages](https://developers.facebook.com/documentation/business-messaging/whatsapp/templates/supported-languages) for all codes.","uniqueKey":"","typeLabel":"string"}},"b7467d83-e984-43bf-bb97-9b2263fef791":{"name":"filter.status","in":"query","description":"Comma-separated template statuses to filter by. Supported values include `PENDING`, `REJECTED`, `APPROVED`, `PAUSED`, `DISABLED`, `ARCHIVED`, `IN_APPEAL`, and `DELETED`.","required":false,"schema":{"type":"string","example":"APPROVED,ARCHIVED","isRequired":false,"description":"Comma-separated template statuses to filter by. Supported values include `PENDING`, `REJECTED`, `APPROVED`, `PAUSED`, `DISABLED`, `ARCHIVED`, `IN_APPEAL`, and `DELETED`.","uniqueKey":"","typeLabel":"string"}}},"responses":{"6edb7bec-6380-42b2-b284-db848e716c79":{"description":"Successfully retrieved a paginated list of objects.","content":{"application/json":{"schema":{"type":"object","description":"Represents a given page of WhatsApp templates.","required":["offset","limit","length"],"properties":{"offset":{"description":"The position of the item this page starts from, zero-based. e.g., the 11th item is at offset 10.","type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"offset","typeLabel":"integer\u003cint32>"},"limit":{"description":"A limit on the number of items to be returned, between 1 and 100, defaults to 10.","type":"integer","format":"int32","minimum":1,"isRequired":true,"uniqueKey":"limit","typeLabel":"integer\u003cint32>"},"length":{"description":"The actual number of items in the page.","type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"length","typeLabel":"integer\u003cint32>"},"total":{"description":"The total number of items. This field is returned only when the request parameter `includeTotal` is set to `true`.","type":"integer","format":"int32","minimum":0,"uniqueKey":"total","typeLabel":"integer\u003cint32>"},"items":{"type":"array","items":{"type":"object","description":"See [WhatsApp Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates).","required":["wabaId","name","language"],"properties":{"wabaId":{"type":"string","description":"WhatsApp Business Account ID.","example":"whatsapp-business-account-id","isRequired":true,"uniqueKey":"\\items.items.[INDEX].wabaId","typeLabel":"string"},"name":{"type":"string","description":"Name of the template.","maxLength":512,"pattern":"[a-z0-9]{1,512}","isRequired":true,"uniqueKey":"\\items.items.[INDEX].name","typeLabel":"string"},"language":{"type":"string","description":"Language code of the template. See [Supported Languages](https://developers.facebook.com/documentation/business-messaging/whatsapp/templates/supported-languages) for all codes.","example":"en","isRequired":true,"uniqueKey":"\\items.items.[INDEX].language","typeLabel":"string"},"officialTemplateId":{"type":"string","description":"Official template ID assigned by WhatsApp. This ID is used to identify the template in WhatsApp's system.","example":"official-template-id","uniqueKey":"\\items.items.[INDEX].officialTemplateId","typeLabel":"string"},"category":{"type":"string","description":"Category of WhatsApp templates.\n- `AUTHENTICATION`: Enable businesses to authenticate users with one-time passcodes, potentially at multiple steps in the login process (e.g., account verification, account recovery, integrity challenges).\n- `MARKETING`: Include promotions or offers, informational updates, or invitations for customers to respond / take action. Any conversation that does not qualify as utility or authentication is a marketing conversation.\n- `UTILITY`: Facilitate a specific, agreed-upon request or transaction or update to a customer about an ongoing transaction, including post-purchase notifications and recurring billing statements.","enum":["AUTHENTICATION","MARKETING","UTILITY"],"uniqueKey":"\\items.items.[INDEX].category","typeLabel":"enum\u003cstring>"},"subCategory":{"type":"string","description":"Subcategory of WhatsApp templates.\n- ORDER_STATUS: Order status template is categorized as `UTILITY` template and apart from name and language of choice, it has general template components such as `BODY`, `FOOTER` and additionally subcategory as `ORDER_STATUS`.","enum":["ORDER_STATUS"],"uniqueKey":"\\items.items.[INDEX].subCategory","typeLabel":"enum\u003cstring>"},"previousCategory":{"type":"string","description":"This field indicates the template's previous category (or `null`, for newly created templates after April 1, 2023). Compare this value to the template's `category` field value, which indicates the template's current category.","uniqueKey":"\\items.items.[INDEX].previousCategory","typeLabel":"string"},"messageSendTtlSeconds":{"type":"integer","format":"int32","description":"If we are unable to deliver a message for an amount of time that exceeds its time-to-live, we will stop retrying and drop the message.\nBy default, messages that use an authentication template have a default TTL of **10 minutes**, and messages that use a utility or marketing template have a default TTL of **30 days**.\nSet its value between `30` and `900` seconds (i.e., 30 seconds to 15 minutes) for authentication templates, or `30` and `43200` seconds (i.e., 30 seconds to 12 hours) for utility templates, or `43200` and `2592000` seconds (i.e., 12 hours to 30 days) for marketing templates. Alternatively, you can set this value to `-1`, which will set a custom TTL of 30 days for either type of template.\nWe encourage you to set a time-to-live for all of your authentication templates, preferably equal to or less than your code expiration time, to ensure your customers only get a message when a code is still usable.\nAuthentication templates created before October 23, 2024, have a default TTL of 30 days.","example":600,"uniqueKey":"\\items.items.[INDEX].messageSendTtlSeconds","typeLabel":"integer\u003cint32>"},"components":{"type":"array","description":"Template components. A template consists of `HEADER`, `BODY`, `FOOTER`, and `BUTTONS` components. `BODY` component is required, the other types are optional.","minItems":1,"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"**Required.** Template component type.\n- `BODY`: Body components are text-only components and are required by all templates. Templates are limited to one body component.\n- `HEADER`: Headers are optional components that appear at the top of template messages. Headers support text, media (images, gif, videos, documents). Templates are limited to one header component.\n- `FOOTER`: Footers are optional text-only components that appear immediately after the body component. Templates are limited to one footer component.\n- `BUTTONS`: Buttons are optional interactive components that perform specific actions when tapped.\n- `LIMITED_TIME_OFFER`: Use for limited-time offer templates. The delivered message can display an offer expiration details section with a heading, an optional expiration timer, and the offer code itself.\n- `CAROUSEL`: Carousel templates allow you to send a single text message (1), accompanied by a set of up to 10 carousel cards (2) in a horizontally scrollable view.\n- `CALL_PERMISSION_REQUEST`: Sending a template message allows you to initiate a user conversation with a call permission request.","enum":["BODY","HEADER","FOOTER","BUTTONS","LIMITED_TIME_OFFER","CAROUSEL","CALL_PERMISSION_REQUEST"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"format":{"type":"string","description":"**Required for type `HEADER`.**","enum":["TEXT","IMAGE","GIF","VIDEO","DOCUMENT","LOCATION"],"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].format","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"For body text (type = `BODY`), maximum 1024 characters.\nFor header text (type = `HEADER`, format = `TEXT`), maximum 60 characters.\nFor footer text (type = `FOOTER`), maximum 60 characters.\nFor card body text (`CAROUSEL` card component type = `BODY`), maximum 160 characters.","maxLength":1024,"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].text","typeLabel":"string"},"buttons":{"type":"array","description":"**Required for type `BUTTONS`.**\nButtons are optional interactive components that perform specific actions when tapped. Templates can have a mixture of up to 10 button components total, although there are limits to individual buttons of the same type as well as combination limits.\nIf a template has more than three buttons, two buttons will appear in the delivered message and the remaining buttons will be replaced with a **See all options** button. Tapping the **See all options** button reveals the remaining buttons.","maxItems":10,"minItems":1,"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The button type that determines the button's behavior when tapped. Supported types include `QUICK_REPLY` (sends predefined text), `URL` (opens a web link), `PHONE_NUMBER` (initiates a call), `COPY_CODE` (copies text to clipboard), `OTP` (one-time password authentication), `CATALOG` (displays product catalog), `MPM` (multi-product message), `FLOW` (WhatsApp Flow), `ORDER_DETAILS` (order review), `VOICE_CALL` (initiates WhatsApp call), and `REQUEST_CONTACT_INFO` (requests the user's contact information).","enum":["PHONE_NUMBER","URL","QUICK_REPLY","COPY_CODE","OTP","CATALOG","MPM","FLOW","ORDER_DETAILS","VOICE_CALL","REQUEST_CONTACT_INFO"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"**Required for button type `PHONE_NUMBER` or `URL`.** Button text.\n**Required for button type `REQUEST_CONTACT_INFO`.** Set it to the fixed value `Share Contact Info`.\nFor `CODE_CODE` buttons, the text is a pre-set value and cannot be customized.\nFor `OTP` buttons, if omitted, the text will default to a pre-set value localized to the template's language. For example, `Copy Code` for English (US). If your template is using a one-tap autofill button and you supply this value, the authentication template message will display a copy code button with this text if we are unable to validate your [handshake](https://developers.facebook.com/docs/whatsapp/business-management-api/authentication-templates/autofill-button-authentication-templates#handshake). Maximum 25 characters.","maxLength":25,"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].text","typeLabel":"string"},"url":{"type":"string","description":"**Required for button type `URL`.** URL of website.\nThere can be at most 1 variable at the end of the URL. Example: `https://www.luckyshrub.com/shop?promo={{1}}`.\n2000 characters maximum.","maxLength":2000,"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].url","typeLabel":"string"},"phone_number":{"type":"string","description":"**Required for button type `PHONE_NUMBER`.**\nAlphanumeric string. Business phone number to be (display phone number) called when the user taps the button.\n20 characters maximum.","maxLength":20,"example":15550051310,"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].phone_number","typeLabel":"string"},"otp_type":{"type":"string","description":"**Required for button type `OTP`.**\nIndicates button OTP type.\nSet to `COPY_CODE` if you want the template to use a copy code button, `ONE_TAP` to have it use a one-tap autofill button, or `ZERO_TAP` to have no button at all.","enum":["COPY_CODE","ONE_TAP","ZERO_TAP"],"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].otp_type","typeLabel":"enum\u003cstring>"},"autofill_text":{"type":"string","description":"**One-tap and zero-tap buttons only.**\nOne-tap button text.\nMaximum 25 characters.","maxLength":25,"example":"Autofill","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].autofill_text","typeLabel":"string"},"package_name":{"type":"string","description":"**Deprecated since 2025-07-23. Use `supported_apps` instead.**\n**One-tap and zero-tap buttons only.**\nYour Android app's package name.","example":"com.example.myapplication","deprecated":true,"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].package_name","typeLabel":"string"},"signature_hash":{"type":"string","description":"**Deprecated since 2025-07-23. Use `supported_apps` instead.**\n**One-tap and zero-tap buttons only.**\nYour app signing key hash. See [App Signing Key Hash](https://developers.facebook.com/docs/whatsapp/business-management-api/authentication-templates/zero-tap-authentication-templates#app-signing-key-hash).","example":"K8a%2FAINcGX7","deprecated":true,"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].signature_hash","typeLabel":"string"},"supported_apps":{"type":"array","description":"**One-tap and zero-tap buttons only.**\nList of supported apps.","items":{"description":"The supported_apps array allows you define pairs of app package names and signing key hashes for up to 5 apps. This can be useful if you have different app builds and want each of them to be able to initiate the handshake:","type":"object","properties":{"package_name":{"type":"string","description":"Your Android app's package name.","example":"com.example.myapplication","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].supported_apps.items.[INDEX].package_name","typeLabel":"string"},"signature_hash":{"type":"string","description":"Your app signing key hash. See [App Signing Key Hash](https://developers.facebook.com/docs/whatsapp/business-management-api/authentication-templates/zero-tap-authentication-templates#app-signing-key-hash).","example":"K8a%2FAINcGX7","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].supported_apps.items.[INDEX].signature_hash","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].supported_apps.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].supported_apps","typeLabel":"object[]"},"zero_tap_terms_accepted":{"type":"boolean","description":"**Zero-tap buttons only.**\nSet to `true` to indicate that you understand that your use of zero-tap authentication is subject to the WhatsApp Business Terms of Service, and that it's your responsibility to ensure your customers expect that the code will be automatically filled in on their behalf when they choose to receive the zero-tap code through WhatsApp.\nIf set to `false`, the template will not be created as you need to accept zero-tap terms before creating zero-tap enabled message templates.","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].zero_tap_terms_accepted","typeLabel":"boolean"},"example":{"type":"array","description":"Sample full URL for a `URL` button with a variable.","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].example.items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].example","typeLabel":"string[]"},"flow_id":{"type":"string","description":"**Conditionally required for button type `FLOW`.**\nThe unique ID of the Flow. Cannot be used if `flow_name` is provided. Use either `flow_id` or `flow_name` when referencing an existing Flow.","example":"1","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].flow_id","typeLabel":"string"},"flow_name":{"type":"string","description":"**Conditionally required for button type `FLOW`.**\nThe name of the Flow. Cannot be used if `flow_id` is provided. Use either `flow_id` or `flow_name` when referencing an existing Flow. The Flow ID is stored in the message template, not the name, so changing the Flow name will not affect existing message templates.","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].flow_name","typeLabel":"string"},"flow_json":{"type":"string","description":"**Conditionally required for button type `FLOW`.**\nThe Flow JSON encoded as string with escaping. The Flow JSON specifies the content of the Flow. Used to pass Flow JSON content/parameters.","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].flow_json","typeLabel":"string"},"flow_action":{"type":"string","description":"**Use for button type `FLOW`.**\nEither `navigate` or `data_exchange`. Defaults to `navigate`.","enum":["navigate","data_exchange"],"example":"navigate","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].flow_action","typeLabel":"enum\u003cstring>"},"navigate_screen":{"type":"string","description":"**Required if `flow_action` is `navigate`.**\nThe unique ID of the Screen in the Flow.","example":"WELCOME_SCREEN","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].navigate_screen","typeLabel":"string"},"app_deep_link":{"type":"object","properties":{"meta_app_id":{"type":"string","description":"Required if using a URL button mapped to a deep link. APP ID.","example":"2892949377516980","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].app_deep_link.meta_app_id","typeLabel":"string"},"android_deep_link":{"type":"string","description":"Required if using a URL button component mapped to a deep link.The WhatsApp client will attempt to load this URI if the WhatsApp user taps the button on an Android device.","example":"luckyshrub://deals/summer/","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].app_deep_link.android_deep_link","typeLabel":"string"},"android_fallback_playstore_url":{"type":"string","description":"Optional. URL of a website that the WhatsApp client will attempt to load in the device’s default web browser when the button is tapped but unable to load the Android deep link URI.","example":"https://www.luckyshrub.com/deals/summer/","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].app_deep_link.android_fallback_playstore_url","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].app_deep_link","typeLabel":"object"}},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].buttons","typeLabel":"object[]"},"add_security_recommendation":{"type":"boolean","description":"**Optional. Only applicable in the `BODY` component of an AUTHENTICATION template.**\nSet to `true` if you want the template to include the string, *For your security, do not share this code.* Set to `false` to exclude the string.","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].add_security_recommendation","typeLabel":"boolean"},"code_expiration_minutes":{"type":"integer","format":"int32","description":"**Optional. Only applicable in the `FOOTER` component of an AUTHENTICATION template.**\nIndicates number of minutes the password or code is valid.\nIf omitted, the code expiration warning will not be displayed in the delivered message.\nMinimum 1, maximum 90.","maximum":90,"minimum":1,"example":5,"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].code_expiration_minutes","typeLabel":"integer\u003cint32>"},"limited_time_offer":{"type":"object","description":"**Required only for component type `LIMITED_TIME_OFFER`.**\nOmit this object for other component types. Its required fields apply only when you include this object.","required":["text"],"properties":{"text":{"type":"string","description":"**Required when you include `limited_time_offer`.**\nOffer details text.\nMaximum 16 characters.","maxLength":16,"example":"Expiring offer!","isRequired":true,"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].limited_time_offer.text","typeLabel":"string"},"has_expiration":{"type":"boolean","description":"**Optional.**\nSet to `true` to have the [offer expiration details](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates/limited-time-offer-templates#offer-expiration-details) appear in the delivered message.\nIf set to `true`, the copy code button component must be included in the `buttons` array, and must appear first in the array.\nIf set to `false`, offer expiration details will not appear in the delivered message and the copy code button component is optional. If including the copy code button, it must appear first in the `buttons` array.","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].limited_time_offer.has_expiration","typeLabel":"boolean"}},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].limited_time_offer","typeLabel":"object"},"example":{"type":"object","description":"**Required** when:\n- `type` is `HEADER`, and `format` is one of `IMAGE`, `GIF`, `VIDEO`, or `DOCUMENT`. Provide a sample media URL in `header_url`.\n- `type` is `HEADER`, `format` is `TEXT`, and a variable is used in `text`. Provide a sample value for that variable in `header_text`. There can be at most 1 variable in `HEADER` text.\n- `type` is `BODY`, and variables are used in `text`. Provide sample values for those variables in `body_text`.","properties":{"body_text":{"type":"array","description":"Sample values for variables in `text` of a `BODY` component.","items":{"type":"array","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].example.body_text.items.[INDEX].items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].example.body_text.items.[INDEX]","typeLabel":"string[]"},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].example.body_text","typeLabel":"string[][]"},"header_text":{"type":"array","description":"Sample value for the variable in `text` of a `HEADER` component.","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].example.header_text.items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].example.header_text","typeLabel":"string[]"},"header_url":{"type":"array","description":"Sample media URL for a `HEADER` component whose format is one of `IMAGE`, `GIF`, `VIDEO`, or `DOCUMENT`.\nSupported types:\n- For `IMAGE`, the URL must end with one of `.jpg`, `.jpeg`, or `.png`, size limit is 5MB.\n- For `GIF`, the URL must end with `.mp4`, size limit is 3.5MB.\n- For `VIDEO`, the URL must end with `.mp4`, size limit is 16MB.\n- For `DOCUMENT`, the URL must end with `.pdf`, size limit is 100MB.","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].example.header_url.items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].example.header_url","typeLabel":"string[]"}},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].example","typeLabel":"object"},"cards":{"type":"array","description":"**Required for type `CAROUSEL`.**\nCarousel templates support up to 10 carousel cards.","maxItems":10,"minItems":1,"items":{"type":"object","description":"Carousel templates support up to 10 carousel cards. Cards must have a media header (image or video) and can optionally include body text and up to 2 quick reply buttons, phone number buttons, or URL buttons (button types can be mixed).","required":["components"],"properties":{"components":{"type":"array","minItems":1,"description":"**Required.**\nCard components.","items":{"type":"object","description":"Cards must have a media header (image or video) and can optionally include body text and up to 2 quick reply buttons, phone number buttons, or URL buttons (button types can be mixed).","required":["type"],"properties":{"type":{"type":"string","description":"**Required.**\nCard component type.\n- `BODY`: Body components are text-only components. Cards must have body text.\n- `HEADER`: Cards must have a media header (image or video).\n- `BUTTONS`: Buttons are interactive components that perform specific actions when tapped. Cards must have at least one button, up to 2 buttons.","enum":["BODY","HEADER","BUTTONS"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"format":{"type":"string","description":"**Required for type `HEADER`.**\nCards must have a media header (image or video).","enum":["IMAGE","VIDEO"],"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].format","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"**Required for type `BODY`.**\nCard body text supports variables. Maximum 160 characters.","maxLength":160,"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].text","typeLabel":"string"},"buttons":{"type":"array","description":"**Required for type `BUTTONS`.**\nCards must have at least one button. Supports 2 buttons. Buttons can be the same or a mix of quick reply buttons, phone number buttons, or URL buttons.","minItems":1,"maxItems":2,"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The button type that determines the button's behavior when tapped. Supported types include `QUICK_REPLY` (sends predefined text), `URL` (opens a web link), `PHONE_NUMBER` (initiates a call), `COPY_CODE` (copies text to clipboard), `OTP` (one-time password authentication), `CATALOG` (displays product catalog), `MPM` (multi-product message), `FLOW` (WhatsApp Flow), `ORDER_DETAILS` (order review), `VOICE_CALL` (initiates WhatsApp call), and `REQUEST_CONTACT_INFO` (requests the user's contact information).","enum":["PHONE_NUMBER","URL","QUICK_REPLY","COPY_CODE","OTP","CATALOG","MPM","FLOW","ORDER_DETAILS","VOICE_CALL","REQUEST_CONTACT_INFO"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"**Required for button type `PHONE_NUMBER` or `URL`.** Button text.\n**Required for button type `REQUEST_CONTACT_INFO`.** Set it to the fixed value `Share Contact Info`.\nFor `CODE_CODE` buttons, the text is a pre-set value and cannot be customized.\nFor `OTP` buttons, if omitted, the text will default to a pre-set value localized to the template's language. For example, `Copy Code` for English (US). If your template is using a one-tap autofill button and you supply this value, the authentication template message will display a copy code button with this text if we are unable to validate your [handshake](https://developers.facebook.com/docs/whatsapp/business-management-api/authentication-templates/autofill-button-authentication-templates#handshake). Maximum 25 characters.","maxLength":25,"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].text","typeLabel":"string"},"url":{"type":"string","description":"**Required for button type `URL`.** URL of website.\nThere can be at most 1 variable at the end of the URL. Example: `https://www.luckyshrub.com/shop?promo={{1}}`.\n2000 characters maximum.","maxLength":2000,"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].url","typeLabel":"string"},"phone_number":{"type":"string","description":"**Required for button type `PHONE_NUMBER`.**\nAlphanumeric string. Business phone number to be (display phone number) called when the user taps the button.\n20 characters maximum.","maxLength":20,"example":15550051310,"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].phone_number","typeLabel":"string"},"otp_type":{"type":"string","description":"**Required for button type `OTP`.**\nIndicates button OTP type.\nSet to `COPY_CODE` if you want the template to use a copy code button, `ONE_TAP` to have it use a one-tap autofill button, or `ZERO_TAP` to have no button at all.","enum":["COPY_CODE","ONE_TAP","ZERO_TAP"],"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].otp_type","typeLabel":"enum\u003cstring>"},"autofill_text":{"type":"string","description":"**One-tap and zero-tap buttons only.**\nOne-tap button text.\nMaximum 25 characters.","maxLength":25,"example":"Autofill","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].autofill_text","typeLabel":"string"},"package_name":{"type":"string","description":"**Deprecated since 2025-07-23. Use `supported_apps` instead.**\n**One-tap and zero-tap buttons only.**\nYour Android app's package name.","example":"com.example.myapplication","deprecated":true,"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].package_name","typeLabel":"string"},"signature_hash":{"type":"string","description":"**Deprecated since 2025-07-23. Use `supported_apps` instead.**\n**One-tap and zero-tap buttons only.**\nYour app signing key hash. See [App Signing Key Hash](https://developers.facebook.com/docs/whatsapp/business-management-api/authentication-templates/zero-tap-authentication-templates#app-signing-key-hash).","example":"K8a%2FAINcGX7","deprecated":true,"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].signature_hash","typeLabel":"string"},"supported_apps":{"type":"array","description":"**One-tap and zero-tap buttons only.**\nList of supported apps.","items":{"description":"The supported_apps array allows you define pairs of app package names and signing key hashes for up to 5 apps. This can be useful if you have different app builds and want each of them to be able to initiate the handshake:","type":"object","properties":{"package_name":{"type":"string","description":"Your Android app's package name.","example":"com.example.myapplication","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].supported_apps.items.[INDEX].package_name","typeLabel":"string"},"signature_hash":{"type":"string","description":"Your app signing key hash. See [App Signing Key Hash](https://developers.facebook.com/docs/whatsapp/business-management-api/authentication-templates/zero-tap-authentication-templates#app-signing-key-hash).","example":"K8a%2FAINcGX7","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].supported_apps.items.[INDEX].signature_hash","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].supported_apps.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].supported_apps","typeLabel":"object[]"},"zero_tap_terms_accepted":{"type":"boolean","description":"**Zero-tap buttons only.**\nSet to `true` to indicate that you understand that your use of zero-tap authentication is subject to the WhatsApp Business Terms of Service, and that it's your responsibility to ensure your customers expect that the code will be automatically filled in on their behalf when they choose to receive the zero-tap code through WhatsApp.\nIf set to `false`, the template will not be created as you need to accept zero-tap terms before creating zero-tap enabled message templates.","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].zero_tap_terms_accepted","typeLabel":"boolean"},"example":{"type":"array","description":"Sample full URL for a `URL` button with a variable.","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].example.items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].example","typeLabel":"string[]"},"flow_id":{"type":"string","description":"**Conditionally required for button type `FLOW`.**\nThe unique ID of the Flow. Cannot be used if `flow_name` is provided. Use either `flow_id` or `flow_name` when referencing an existing Flow.","example":"1","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].flow_id","typeLabel":"string"},"flow_name":{"type":"string","description":"**Conditionally required for button type `FLOW`.**\nThe name of the Flow. Cannot be used if `flow_id` is provided. Use either `flow_id` or `flow_name` when referencing an existing Flow. The Flow ID is stored in the message template, not the name, so changing the Flow name will not affect existing message templates.","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].flow_name","typeLabel":"string"},"flow_json":{"type":"string","description":"**Conditionally required for button type `FLOW`.**\nThe Flow JSON encoded as string with escaping. The Flow JSON specifies the content of the Flow. Used to pass Flow JSON content/parameters.","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].flow_json","typeLabel":"string"},"flow_action":{"type":"string","description":"**Use for button type `FLOW`.**\nEither `navigate` or `data_exchange`. Defaults to `navigate`.","enum":["navigate","data_exchange"],"example":"navigate","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].flow_action","typeLabel":"enum\u003cstring>"},"navigate_screen":{"type":"string","description":"**Required if `flow_action` is `navigate`.**\nThe unique ID of the Screen in the Flow.","example":"WELCOME_SCREEN","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].navigate_screen","typeLabel":"string"},"app_deep_link":{"type":"object","properties":{"meta_app_id":{"type":"string","description":"Required if using a URL button mapped to a deep link. APP ID.","example":"2892949377516980","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].app_deep_link.meta_app_id","typeLabel":"string"},"android_deep_link":{"type":"string","description":"Required if using a URL button component mapped to a deep link.The WhatsApp client will attempt to load this URI if the WhatsApp user taps the button on an Android device.","example":"luckyshrub://deals/summer/","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].app_deep_link.android_deep_link","typeLabel":"string"},"android_fallback_playstore_url":{"type":"string","description":"Optional. URL of a website that the WhatsApp client will attempt to load in the device’s default web browser when the button is tapped but unable to load the Android deep link URI.","example":"https://www.luckyshrub.com/deals/summer/","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].app_deep_link.android_fallback_playstore_url","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX].app_deep_link","typeLabel":"object"}},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].buttons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].buttons","typeLabel":"object[]"},"example":{"type":"object","description":"**Required** when:\n- `type` is `HEADER`, and `format` is one of `IMAGE`, `GIF`, `VIDEO`, or `DOCUMENT`. Provide a sample media URL in `header_url`.\n- `type` is `HEADER`, `format` is `TEXT`, and a variable is used in `text`. Provide a sample value for that variable in `header_text`. There can be at most 1 variable in `HEADER` text.\n- `type` is `BODY`, and variables are used in `text`. Provide sample values for those variables in `body_text`.","properties":{"body_text":{"type":"array","description":"Sample values for variables in `text` of a `BODY` component.","items":{"type":"array","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].example.body_text.items.[INDEX].items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].example.body_text.items.[INDEX]","typeLabel":"string[]"},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].example.body_text","typeLabel":"string[][]"},"header_text":{"type":"array","description":"Sample value for the variable in `text` of a `HEADER` component.","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].example.header_text.items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].example.header_text","typeLabel":"string[]"},"header_url":{"type":"array","description":"Sample media URL for a `HEADER` component whose format is one of `IMAGE`, `GIF`, `VIDEO`, or `DOCUMENT`.\nSupported types:\n- For `IMAGE`, the URL must end with one of `.jpg`, `.jpeg`, or `.png`, size limit is 5MB.\n- For `GIF`, the URL must end with `.mp4`, size limit is 3.5MB.\n- For `VIDEO`, the URL must end with `.mp4`, size limit is 16MB.\n- For `DOCUMENT`, the URL must end with `.pdf`, size limit is 100MB.","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].example.header_url.items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].example.header_url","typeLabel":"string[]"}},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX].example","typeLabel":"object"}},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX].components","typeLabel":"object[]"}},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX].cards","typeLabel":"object[]"}},"uniqueKey":"\\items.items.[INDEX].components.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].components","typeLabel":"object[]"},"ctaUrlLinkTrackingOptedOut":{"type":"boolean","description":"Whether Meta CTA URL click tracking is disabled. Historical `null` values are returned as `true`.","example":true,"uniqueKey":"\\items.items.[INDEX].ctaUrlLinkTrackingOptedOut","typeLabel":"boolean"},"status":{"type":"string","description":"The status of a WhatsApp template.\n- `PENDING`: The template is still under review. Review can take up to 24 hours.\n- `REJECTED`: The template has been rejected during review process.\n- `APPROVED`: The template is approved, and you may begin sending it to customers.\n- `PAUSED`: The template has been paused due to recurring negative feedback from customers. Message templates with this status cannot be sent to customers. See [Template Pausing](https://developers.facebook.com/docs/whatsapp/message-templates/guidelines#template-pausing).\n- `DISABLED`: The template has been disabled due to recurring negative feedback from customers or for violating one or more of our policies. Message templates with this status cannot be sent to customers. You may be able to edit a disabled message template and request an appeal. See [Appeals](https://developers.facebook.com/docs/whatsapp/message-templates/guidelines#appeals).\n- `ARCHIVED`: The template has been archived. Archived templates cannot be sent or edited.\n- `IN_APPEAL`: The template is in appeal. See also [Template Appeals](https://developers.facebook.com/docs/whatsapp/message-templates/guidelines#appeals).\n- `DELETED`: The template is deleted.","enum":["PENDING","REJECTED","APPROVED","PAUSED","DISABLED","ARCHIVED","IN_APPEAL","DELETED"],"example":"REJECTED","uniqueKey":"\\items.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"qualityRating":{"type":"string","description":"Quality rating of WhatsApp template. One of `GREEN`, `YELLOW`, `RED`, or `UNKNOWN`. See also [Template Quality Rating](https://developers.facebook.com/docs/whatsapp/message-templates/guidelines/#quality-rating).\n- `GREEN`: High quality.\n- `YELLOW`: Medium quality.\n- `RED`: Low quality.\n- `UNKNOWN`: Unknown quality.","enum":["GREEN","YELLOW","RED","UNKNOWN"],"uniqueKey":"\\items.items.[INDEX].qualityRating","typeLabel":"enum\u003cstring>"},"reason":{"type":"string","description":"The reason why the template is rejected.","uniqueKey":"\\items.items.[INDEX].reason","typeLabel":"string"},"createTime":{"type":"string","format":"date-time","description":"The time at which this object is created, formatted in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). e.g., `2022-06-01T12:00:00.000Z`.","example":"2022-06-01T12:00:00.000Z","uniqueKey":"\\items.items.[INDEX].createTime","typeLabel":"string\u003cdate-time>"},"updateTime":{"type":"string","format":"date-time","description":"The time at which this object is updated, formatted in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). e.g., `2022-06-01T12:00:00.000Z`.","example":"2022-06-01T12:00:00.000Z","uniqueKey":"\\items.items.[INDEX].updateTime","typeLabel":"string\u003cdate-time>"},"statusUpdateEvent":{"type":"string","description":"The WhatsApp template status update event that caused this webhook. For `ARCHIVED`, the template `status` is `ARCHIVED`. For `UNARCHIVED`, the template `status` is the current status returned by Meta, for example `APPROVED`; it does not represent a new approval review.","enum":["PENDING","APPROVED","REJECTED","IN_APPEAL","PAUSED","FLAGGED","DISABLED","ARCHIVED","UNARCHIVED","REINSTATED","PENDING_DELETION"],"uniqueKey":"\\items.items.[INDEX].statusUpdateEvent","typeLabel":"enum\u003cstring>"},"disableDate":{"type":"string","description":"The date at which the template will be disabled. When a WhatsApp template `FLAGGED` event is received, this field is set.","example":"December 9, 2022","uniqueKey":"\\items.items.[INDEX].disableDate","typeLabel":"string"},"whatsappApiError":{"type":"object","description":"The original error object returned by WhatsApp. See [Handling Errors](https://developers.facebook.com/docs/graph-api/guides/error-handling), [Cloud API Error Codes](https://developers.facebook.com/docs/whatsapp/cloud-api/support/error-codes).","required":["message","code"],"properties":{"message":{"type":"string","description":"A human-readable description of the error.","example":"HSM Template creation failed","isRequired":true,"uniqueKey":"\\items.items.[INDEX].whatsappApiError.message","typeLabel":"string"},"code":{"type":"string","description":"An error code.","example":200002,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].whatsappApiError.code","typeLabel":"string"},"type":{"type":"string","description":"Error type.","example":"OAuthException","uniqueKey":"\\items.items.[INDEX].whatsappApiError.type","typeLabel":"string"},"is_transient":{"type":"boolean","description":"Whether the error is transient.","example":false,"uniqueKey":"\\items.items.[INDEX].whatsappApiError.is_transient","typeLabel":"boolean"},"error_subcode":{"type":"string","description":"Additional code about the error.","example":2388109,"uniqueKey":"\\items.items.[INDEX].whatsappApiError.error_subcode","typeLabel":"string"},"error_user_msg":{"type":"string","description":"The message to display to the user. The language of the message is based on the locale of the API request.","example":"This message template cannot be created.","uniqueKey":"\\items.items.[INDEX].whatsappApiError.error_user_msg","typeLabel":"string"},"error_user_title":{"type":"string","description":"The title of the dialog, if shown. The language of the message is based on the locale of the API request.","example":"Message Cannot Be Submitted","uniqueKey":"\\items.items.[INDEX].whatsappApiError.error_user_title","typeLabel":"string"},"fbtrace_id":{"type":"string","description":"Internal support identifier. When reporting a bug related to a Graph API call, include the fbtrace_id to help us find log data for debugging.","example":"AVGjJ7ia2zJkrHG","uniqueKey":"\\items.items.[INDEX].whatsappApiError.fbtrace_id","typeLabel":"string"},"error_data":{"oneOf":[{"type":"string","description":"Additional data about the error. A string or map.\n- For template APIs, this field is a string describing the reason for the error.\n- For message APIs, this field is a map with property `details` describing the reason for the error.","uniqueKey":"\\items.items.[INDEX].whatsappApiError.error_data.oneOf.0","typeLabel":"string"},{"type":"object","description":"Additional data about the error. A string or map.\n- For template APIs, this field is a string describing the reason for the error.\n- For message APIs, this field is a map with property `details` describing the reason for the error.","additionalProperties":true,"uniqueKey":"\\items.items.[INDEX].whatsappApiError.error_data.oneOf.1","typeLabel":"object"}],"uniqueKey":"\\items.items.[INDEX].whatsappApiError.error_data","typeLabel":"string | object"}},"uniqueKey":"\\items.items.[INDEX].whatsappApiError","typeLabel":"object"}},"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"description":"An array containing WhatsApp template objects.","uniqueKey":"\\items","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"offset":1,"limit":2,"length":1,"total":1,"items":[{"wabaId":"whatsapp-business-account-id","name":"\u003cstring>","language":"en","officialTemplateId":"official-template-id","category":"AUTHENTICATION","subCategory":"ORDER_STATUS","previousCategory":"\u003cstring>","messageSendTtlSeconds":600,"components":[{"type":"BODY","format":"TEXT","text":"\u003cstring>","buttons":[{"type":"PHONE_NUMBER","text":"\u003cstring>","url":"\u003cstring>","phone_number":15550051310,"otp_type":"COPY_CODE","autofill_text":"Autofill","package_name":"com.example.myapplication","signature_hash":"K8a%2FAINcGX7","supported_apps":[{"package_name":"com.example.myapplication","signature_hash":"K8a%2FAINcGX7"}],"zero_tap_terms_accepted":true,"example":["\u003cstring>"],"flow_id":"1","flow_name":"\u003cstring>","flow_json":"\u003cstring>","flow_action":"navigate","navigate_screen":"WELCOME_SCREEN","app_deep_link":{"meta_app_id":"2892949377516980","android_deep_link":"luckyshrub://deals/summer/","android_fallback_playstore_url":"https://www.luckyshrub.com/deals/summer/"}}],"add_security_recommendation":true,"code_expiration_minutes":5,"limited_time_offer":{"text":"Expiring offer!","has_expiration":true},"example":{"body_text":[["\u003cstring>"]],"header_text":["\u003cstring>"],"header_url":["\u003cstring>"]},"cards":[{"components":[{"type":"BODY","format":"IMAGE","text":"\u003cstring>","buttons":[{"type":"PHONE_NUMBER","text":"\u003cstring>","url":"\u003cstring>","phone_number":15550051310,"otp_type":"COPY_CODE","autofill_text":"Autofill","package_name":"com.example.myapplication","signature_hash":"K8a%2FAINcGX7","supported_apps":[{"package_name":"com.example.myapplication","signature_hash":"K8a%2FAINcGX7"}],"zero_tap_terms_accepted":true,"example":["\u003cstring>"],"flow_id":"1","flow_name":"\u003cstring>","flow_json":"\u003cstring>","flow_action":"navigate","navigate_screen":"WELCOME_SCREEN","app_deep_link":{"meta_app_id":"2892949377516980","android_deep_link":"luckyshrub://deals/summer/","android_fallback_playstore_url":"https://www.luckyshrub.com/deals/summer/"}}],"example":{"body_text":[["\u003cstring>"]],"header_text":["\u003cstring>"],"header_url":["\u003cstring>"]}}]}]}],"ctaUrlLinkTrackingOptedOut":true,"status":"REJECTED","qualityRating":"GREEN","reason":"\u003cstring>","createTime":"2022-06-01T12:00:00.000Z","updateTime":"2022-06-01T12:00:00.000Z","statusUpdateEvent":"PENDING","disableDate":"December 9, 2022","whatsappApiError":{"message":"HSM Template creation failed","code":200002,"type":"OAuthException","is_transient":false,"error_subcode":2388109,"error_user_msg":"This message template cannot be created.","error_user_title":"Message Cannot Be Submitted","fbtrace_id":"AVGjJ7ia2zJkrHG","error_data":"\u003cstring>"}}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"b10e61f5-7bed-4fad-8aee-6f7090632636":{"api_key":{"type":"apiKey","name":"X-API-Key","in":"header","scopes":[],"schemeName":"api_key"}}},"servers":{"e1a7c0ed-75fc-4496-9a27-11224882ca56":{"url":"https://api.ycloud.com/v2","description":"Base URL"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"X-API-Key","in":"header","scopes":[],"schemeName":"api_key"},"schema":{"title":"X-API-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api_key","name":"X-API-Key"}],"title":"api_key"}]},"originalFileLocation":"openapi/endpoints/ycloud-api-v2.yaml"},"subdomain":"lchnan","siteName":"YCloud Docs","title":"List templates - YCloud Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/whatsapp-templates/list-templates","matchLevel":0},"zh":{"href":"/api-reference/whatsapp-templates/list-templates","matchLevel":0},"es":{"href":"/api-reference/whatsapp-templates/list-templates","matchLevel":0},"pt":{"href":"/api-reference/whatsapp-templates/list-templates","matchLevel":0},"ru":{"href":"/api-reference/whatsapp-templates/list-templates","matchLevel":0}}},"lastModified":"2026-10-27T06:32:06.743Z","originalFileLocation":"api-reference/whatsapp-templates/list-templates.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=\"Returns a paginated list of WhatsApp templates you\u0026#x27;ve previously created. Archived templates are included when they match the query. Use filter.status=ARCHIVED to list archived templates explicitly.\">\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=\"List templates - YCloud Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a paginated list of WhatsApp templates you\u0026#x27;ve previously created. Archived templates are included when they match the query. Use filter.status=ARCHIVED to list archived templates explicitly.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"YCloud Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ycloud.com/api-reference/whatsapp-templates/list-templates\">\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=WhatsApp+Templates\u0026amp;title=List+templates\u0026amp;description=Returns+a+paginated+list+of+WhatsApp+templates+you%27ve+previously+created.%0A%0AArchived+templates+are+included+when+they+match+the+query.+Use+%60filter.status%3DARCHIVE\u0026amp;theme=7e639de6347778391fbe3ad7\u0026amp;signature=cb8e02ebbd52c09735e7ed6a388769f06100ee815576d1d9c7396c519e19424b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List templates - YCloud Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a paginated list of WhatsApp templates you\u0026#x27;ve previously created. Archived templates are included when they match the query. Use filter.status=ARCHIVED to list archived templates explicitly.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lchnan.mintlify.app/_mintlify/api/og/v2?division=WhatsApp+Templates\u0026amp;title=List+templates\u0026amp;description=Returns+a+paginated+list+of+WhatsApp+templates+you%27ve+previously+created.%0A%0AArchived+templates+are+included+when+they+match+the+query.+Use+%60filter.status%3DARCHIVE\u0026amp;theme=7e639de6347778391fbe3ad7\u0026amp;signature=cb8e02ebbd52c09735e7ed6a388769f06100ee815576d1d9c7396c519e19424b\">\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/api-reference/whatsapp-templates/list-templates\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/whatsapp-templates/list-templates.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/api-reference/whatsapp-templates/list-templates#webpage\",\"url\":\"https://docs.ycloud.com/api-reference/whatsapp-templates/list-templates\",\"name\":\"List templates\",\"description\":\"Returns a paginated list of WhatsApp templates you've previously created. Archived templates are included when they match the query. Use filter.status=ARCHIVED to list archived templates explicitly.\",\"dateModified\":\"2026-10-27T06:32:06.743Z\",\"isPartOf\":{\"@id\":\"https://docs.ycloud.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ycloud.com/api-reference/whatsapp-templates/list-templates#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ycloud.com/api-reference/whatsapp-templates/list-templates#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.ycloud.com/api-reference/whatsapp-business-accounts/list-wabas\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"WhatsApp Templates\",\"item\":\"https://docs.ycloud.com/api-reference/whatsapp-templates/create-a-template\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"List templates\",\"item\":\"https://docs.ycloud.com/api-reference/whatsapp-templates/list-templates\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.ycloud.com/api-reference/whatsapp-templates/list-templates#apireference\",\"headline\":\"List templates\",\"name\":\"List templates\",\"description\":\"Returns a paginated list of WhatsApp templates you've previously created. Archived templates are included when they match the query. Use filter.status=ARCHIVED to list archived templates explicitly.\",\"url\":\"https://docs.ycloud.com/api-reference/whatsapp-templates/list-templates\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ycloud.com/api-reference/whatsapp-templates/list-templates#webpage\"},\"dateModified\":\"2026-10-27T06:32:06.743Z\",\"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","pages":[{"title":"Documentation","href":"/en/documentation/overview"}]},{"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","description":"Creates a WhatsApp template.\n\nInclude `limited_time_offer` only in a component whose `type` is `LIMITED_TIME_OFFER`. Other component types do not require this object or its `text` field.","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","description":"Returns daily YCloud message metrics and, when available, Meta Template Insights\nfor one WhatsApp template. Authenticate with `X-API-Key`.\n`analyticsStatus` describes Meta Template Insights only; it does not describe YCloud metrics.\nDates are interpreted in the WABA timezone, both boundaries are inclusive, and the range\nmust contain between 1 and 90 calendar days.\n\nThe selected template must currently exist under the requested WABA. REST resolves and\nvalidates the template before querying any statistics. A missing template returns `404`,\na template that belongs to another WABA returns `403`, and a template lookup failure returns\n`500`; none of these errors returns partial statistics.","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","pages":[{"title":"Partner Center","href":"/en/partner-center/overview"}]}]},{"language":"zh","tabs":[{"tab":"产品文档","icon":"book-open","pages":[{"title":"产品文档","href":"/zh/documentation/overview"}]},{"tab":"API 参考","icon":"code","groups":[{"group":"开始使用","pages":[{"title":"YCloud API","href":"/zh/api-reference/getting-started/ycloud-api"},{"title":"快速入门","href":"/zh/api-reference/getting-started/quickstart"},{"title":"API 更新日志","href":"/zh/api-reference/getting-started/changelog"}]},{"group":"指南","pages":[{"title":"指南","href":"/zh/api-reference/guides/overview"},{"group":"API 基础","pages":[{"title":"身份验证","href":"/zh/api-reference/guides/api-fundamentals/authentication"},{"title":"错误处理","href":"/zh/api-reference/guides/api-fundamentals/handle-errors"},{"title":"速率限制","href":"/zh/api-reference/guides/api-fundamentals/rate-limits"},{"title":"分页","href":"/zh/api-reference/guides/api-fundamentals/pagination"},{"title":"API 版本控制与兼容性","href":"/zh/api-reference/guides/api-fundamentals/versioning"},{"title":"配置 Webhook","href":"/zh/api-reference/guides/api-fundamentals/configure-webhooks"},{"title":"实现 Webhook 接收器","href":"/zh/api-reference/guides/api-fundamentals/implement-a-webhook-receiver"}]},{"group":"WhatsApp 平台","pages":[{"group":"发送与接收","pages":[{"title":"发送 WhatsApp 消息","href":"/zh/api-reference/guides/whatsapp-platform/send-whatsapp-message"},{"title":"WhatsApp 错误代码","href":"/zh/api-reference/guides/whatsapp-platform/whatsapp-error-code"},{"title":"处理 WhatsApp 入站消息","href":"/zh/api-reference/guides/whatsapp-platform/handle-whatsapp-inbound-messages"},{"title":"上传 WhatsApp 媒体","href":"/zh/api-reference/guides/whatsapp-platform/upload-whatsapp-media"},{"title":"WhatsApp 消息定价接入指南","href":"/zh/api-reference/guides/whatsapp-platform/whatsapp-message-pricing-integration-guide"},{"title":"最高出价(Max Price)集成指南","href":"/zh/api-reference/guides/whatsapp-platform/max-price-integration-guide"}]},{"group":"最佳实践","pages":[{"title":"WhatsApp Messages API 最佳实践","href":"/zh/api-reference/guides/whatsapp-platform/whatsapp-messages-api-best-practices"},{"title":"Direct Send 最佳实践","href":"/zh/api-reference/guides/whatsapp-platform/best-practices/direct-send"}]},{"group":"商业账户","pages":[{"title":"管理 WhatsApp 商业账户","href":"/zh/api-reference/guides/whatsapp-platform/manage-whatsapp-business-accounts"},{"title":"管理 WhatsApp 电话号码","href":"/zh/api-reference/guides/whatsapp-platform/manage-whatsapp-phone-numbers"},{"title":"使用业务范围用户 ID","href":"/zh/api-reference/guides/whatsapp-platform/use-business-scoped-user-ids"}]},{"group":"模板与流程","pages":[{"title":"管理 WhatsApp 模板","href":"/zh/api-reference/guides/whatsapp-platform/manage-whatsapp-templates"},{"title":"支持的 WhatsApp 消息模板语言","href":"/zh/api-reference/guides/whatsapp-platform/supported-whatsapp-template-languages"},{"title":"管理 WhatsApp Flows","href":"/zh/api-reference/guides/whatsapp-platform/manage-whatsapp-flows"},{"title":"实现 WhatsApp Flow 端点","href":"/zh/api-reference/guides/whatsapp-platform/implement-a-whatsapp-flow-endpoint"}]},{"group":"通话与群组","pages":[{"title":"管理 WhatsApp 通话","href":"/zh/api-reference/guides/whatsapp-platform/manage-whatsapp-calls"},{"title":"管理 WhatsApp 群组","href":"/zh/api-reference/guides/whatsapp-platform/manage-whatsapp-groups"}]}]},{"group":"Meta 商业智能体","pages":[{"title":"Meta Business Agent 概述","href":"/zh/documentation/meta-business-agent/overview"},{"title":"准备并检查资格","href":"/zh/documentation/meta-business-agent/prepare-and-check-eligibility"},{"title":"接入与配置","href":"/zh/documentation/meta-business-agent/onboard-and-configure"},{"title":"测试与评估","href":"/zh/documentation/meta-business-agent/test-and-evaluate"},{"title":"安全发布","href":"/zh/documentation/meta-business-agent/roll-out-safely"},{"title":"操作与故障排除","href":"/zh/documentation/meta-business-agent/operate-and-troubleshoot"}]},{"group":"客户数据与运营","pages":[{"title":"查询账户余额","href":"/zh/api-reference/guides/customer-data-and-operations/check-account-balance"},{"title":"管理联系人","href":"/zh/api-reference/guides/customer-data-and-operations/manage-contacts"},{"title":"跟踪自定义事件","href":"/zh/api-reference/guides/customer-data-and-operations/track-custom-events"},{"title":"管理退订用户","href":"/zh/api-reference/guides/customer-data-and-operations/manage-unsubscribers"}]},{"group":"示例","pages":[{"title":"API 与 Webhook 示例","href":"/zh/api-reference/guides/examples/overview"},{"group":"API 示例","pages":[{"title":"WhatsApp 消息模板创建示例","href":"/zh/api-reference/guides/examples/api-examples/whatsapp-template-creation-examples"},{"title":"WhatsApp 消息发送示例","href":"/zh/api-reference/guides/examples/api-examples/whatsapp-messaging-examples"}]},{"group":"Webhook 示例","pages":[{"title":"Webhook 示例","href":"/zh/api-reference/guides/examples/webhook-examples/overview"},{"group":"消息","pages":[{"title":"消息状态 Webhook 示例","href":"/zh/api-reference/guides/examples/webhook-examples/whatsapp-message-updated-webhook-examples"},{"title":"入站消息和偏好 Webhook 示例","href":"/zh/api-reference/guides/examples/webhook-examples/whatsapp-inbound-message-webhook-examples"}]},{"group":"Meta Business Agent","pages":[{"title":"Meta Business Agent echo 消息已创建","sidebarTitle":"Echo 消息已创建","href":"/zh/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created"},{"title":"Meta Business Agent 回显消息已更新","sidebarTitle":"回显消息已更新","href":"/zh/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-updated"},{"title":"Meta Business Agent 控制权移交","sidebarTitle":"控制权移交","href":"/zh/api-reference/guides/examples/webhook-examples/whatsapp-meta-business-agent-handover-updated"}]},{"group":"WhatsApp Business App","pages":[{"title":"WhatsApp Business App 历史消息 Webhook 示例","href":"/zh/api-reference/guides/examples/webhook-examples/whatsapp-business-app-history-message-webhook-examples"},{"title":"WhatsApp Business App 已发送消息同步 Webhook 示例","href":"/zh/api-reference/guides/examples/webhook-examples/whatsapp-business-app-sent-message-sync-webhook-examples"}]},{"group":"模板与账户","pages":[{"title":"WhatsApp 模板 Webhook 示例","href":"/zh/api-reference/guides/examples/webhook-examples/whatsapp-template-reviewed-webhook-examples"},{"title":"WhatsApp 账户和电话号码 Webhook 示例","href":"/zh/api-reference/guides/examples/webhook-examples/whatsapp-business-account-updated-webhook-examples"}]},{"group":"通话","pages":[{"title":"WhatsApp 呼叫连接 Webhook 示例","href":"/zh/api-reference/guides/examples/webhook-examples/whatsapp-calling-connect-webhook-examples"},{"title":"WhatsApp 通话状态更新 Webhook 示例","href":"/zh/api-reference/guides/examples/webhook-examples/whatsapp-calling-status-update-webhook-examples"},{"title":"WhatsApp 通话结束与捕获 Webhook 示例","href":"/zh/api-reference/guides/examples/webhook-examples/whatsapp-calling-terminate-webhook-examples"}]},{"group":"群组","pages":[{"title":"WhatsApp 群组生命周期更新 Webhook 示例","href":"/zh/api-reference/guides/examples/webhook-examples/whatsapp-group-lifecycle-update-webhook-examples"},{"title":"WhatsApp 群组成员更新 Webhook 示例","href":"/zh/api-reference/guides/examples/webhook-examples/whatsapp-group-participants-update-webhook-examples"},{"title":"WhatsApp 群组设置更新 Webhook 示例","href":"/zh/api-reference/guides/examples/webhook-examples/whatsapp-group-settings-update-webhook-examples"},{"title":"WhatsApp 群组状态更新 Webhook 示例","href":"/zh/api-reference/guides/examples/webhook-examples/whatsapp-group-status-update-webhook-examples"}]},{"group":"Flows","pages":[{"title":"WhatsApp Flow Webhook 示例","href":"/zh/api-reference/guides/examples/webhook-examples/whatsapp-flow-webhook-examples"}]},{"group":"支付","pages":[{"title":"WhatsApp 支付更新 Webhook 示例","href":"/zh/api-reference/guides/examples/webhook-examples/whatsapp-payment-updated-webhook-examples"}]},{"group":"联系人与退订","pages":[{"title":"联系人及备注创建 Webhook 示例","href":"/zh/api-reference/guides/examples/webhook-examples/contact-created-webhook-examples"},{"title":"联系人及备注删除 Webhook 示例","href":"/zh/api-reference/guides/examples/webhook-examples/contact-deleted-webhook-examples"},{"title":"联系人及便签更新 Webhook 示例","href":"/zh/api-reference/guides/examples/webhook-examples/contact-attributes-changed-webhook-examples"},{"title":"联系人退订创建 Webhook 示例","href":"/zh/api-reference/guides/examples/webhook-examples/contact-unsubscribe-created-webhook-examples"},{"title":"联系人退订删除 Webhook 示例","href":"/zh/api-reference/guides/examples/webhook-examples/contact-unsubscribe-deleted-webhook-examples"}]},{"title":"Webhook 载荷示例","href":"/zh/api-reference/guides/examples/webhook-examples/webhook-payload-examples"}]}]}]},{"group":"接口","pages":[{"group":"WhatsApp 业务账号","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 入站消息","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 媒体","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 消息","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 消息","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 屏蔽用户","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 群组","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 语音通话","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 电话号码","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 模板","pages":[{"title":"Create a template","description":"Creates a WhatsApp template.\n\nInclude `limited_time_offer` only in a component whose `type` is `LIMITED_TIME_OFFER`. Other component types do not require this object or its `text` field.","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","description":"Returns daily YCloud message metrics and, when available, Meta Template Insights\nfor one WhatsApp template. Authenticate with `X-API-Key`.\n`analyticsStatus` describes Meta Template Insights only; it does not describe YCloud metrics.\nDates are interpreted in the WABA timezone, both boundaries are inclusive, and the range\nmust contain between 1 and 90 calendar days.\n\nThe selected template must currently exist under the requested WABA. REST resolves and\nvalidates the template before querying any statistics. A missing template returns `404`,\na template that belongs to another WABA returns `403`, and a template lookup failure returns\n`500`; none of these errors returns partial statistics.","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":"余额","pages":[{"title":"Retrieve balance","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /balance","href":"/api-reference/balance/retrieve-balance"}]},{"group":"联系人","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":"自定义事件","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":"邮件","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":"短信","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":"退订用户","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":"验证码","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":"语音","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 端点","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 商业智能体","pages":[{"title":"Meta Business Agent 概述","href":"/zh/api-reference/meta-business-agents/overview"},{"group":"配置","pages":[{"group":"智能体知识:企业信息","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":"智能体知识:常见问题","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":"智能体知识:文件","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":"智能体知识:网站","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":"智能体技能","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":"界面技能","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":"连接器工具","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":"连接器","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":"删除智能体","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":"接入","pages":[{"group":"智能体白名单","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":"智能体资格","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":"智能体接入","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":"智能体设置","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":"智能体预算","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":"运行","pages":[{"group":"智能体评估","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":"智能体事件","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":"智能体测试","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":"对话轮次","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":"会话控制(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":"测试 Webhook","sidebarTitle":"测试 Webhook","openapi":"openapi/webhooks/testing-webhooks.yaml POST /webhooks/ycloud","playground":"interactive","href":"/zh/api-reference/webhooks/test-webhooks"}]}]},{"tab":"合作伙伴中心","icon":"handshake","pages":[{"title":"合作伙伴中心","href":"/zh/partner-center/overview"}]}]},{"language":"es","tabs":[{"tab":"Documentación","icon":"book-open","pages":[{"title":"Documentación","href":"/es/documentation/overview"}]},{"tab":"Referencia de la API","icon":"code","groups":[{"group":"Primeros pasos","pages":[{"title":"API de YCloud","href":"/es/api-reference/getting-started/ycloud-api"},{"title":"Inicio rápido","href":"/es/api-reference/getting-started/quickstart"},{"title":"Registro de cambios de la API","href":"/es/api-reference/getting-started/changelog"}]},{"group":"Guías","pages":[{"title":"Guías","href":"/es/api-reference/guides/overview"},{"group":"Fundamentos de la API","pages":[{"title":"Autenticación","href":"/es/api-reference/guides/api-fundamentals/authentication"},{"title":"Manejo de errores","href":"/es/api-reference/guides/api-fundamentals/handle-errors"},{"title":"Límites de tasa","href":"/es/api-reference/guides/api-fundamentals/rate-limits"},{"title":"Paginación","href":"/es/api-reference/guides/api-fundamentals/pagination"},{"title":"Control de versiones y compatibilidad de la API","href":"/es/api-reference/guides/api-fundamentals/versioning"},{"title":"Configurar webhooks","href":"/es/api-reference/guides/api-fundamentals/configure-webhooks"},{"title":"Implementar un receptor de webhooks","href":"/es/api-reference/guides/api-fundamentals/implement-a-webhook-receiver"}]},{"group":"Plataforma de WhatsApp","pages":[{"group":"Enviar y recibir","pages":[{"title":"Enviar un mensaje de WhatsApp","href":"/es/api-reference/guides/whatsapp-platform/send-whatsapp-message"},{"title":"Código de error de WhatsApp","href":"/es/api-reference/guides/whatsapp-platform/whatsapp-error-code"},{"title":"Gestionar mensajes entrantes de WhatsApp","href":"/es/api-reference/guides/whatsapp-platform/handle-whatsapp-inbound-messages"},{"title":"Subir archivos multimedia de WhatsApp","href":"/es/api-reference/guides/whatsapp-platform/upload-whatsapp-media"},{"title":"Guía de integración de precios de mensajes de WhatsApp","href":"/es/api-reference/guides/whatsapp-platform/whatsapp-message-pricing-integration-guide"},{"title":"Guía de integración de Max Price","href":"/es/api-reference/guides/whatsapp-platform/max-price-integration-guide"}]},{"group":"Buenas prácticas","pages":[{"title":"Prácticas recomendadas para la API de mensajes de WhatsApp","href":"/es/api-reference/guides/whatsapp-platform/whatsapp-messages-api-best-practices"},{"title":"Mejores prácticas para Direct Send","href":"/es/api-reference/guides/whatsapp-platform/best-practices/direct-send"}]},{"group":"Cuentas comerciales","pages":[{"title":"Gestionar cuentas de WhatsApp Business","href":"/es/api-reference/guides/whatsapp-platform/manage-whatsapp-business-accounts"},{"title":"Administrar números de teléfono de WhatsApp","href":"/es/api-reference/guides/whatsapp-platform/manage-whatsapp-phone-numbers"},{"title":"Usar ID de usuario con ámbito de negocio (BSUID)","href":"/es/api-reference/guides/whatsapp-platform/use-business-scoped-user-ids"}]},{"group":"Plantillas y flujos","pages":[{"title":"Administrar plantillas de WhatsApp","href":"/es/api-reference/guides/whatsapp-platform/manage-whatsapp-templates"},{"title":"Idiomas admitidos para plantillas de WhatsApp","href":"/es/api-reference/guides/whatsapp-platform/supported-whatsapp-template-languages"},{"title":"Gestionar WhatsApp Flows","href":"/es/api-reference/guides/whatsapp-platform/manage-whatsapp-flows"},{"title":"Implementar un endpoint de WhatsApp Flow","href":"/es/api-reference/guides/whatsapp-platform/implement-a-whatsapp-flow-endpoint"}]},{"group":"Llamadas y grupos","pages":[{"title":"Gestionar llamadas de WhatsApp","href":"/es/api-reference/guides/whatsapp-platform/manage-whatsapp-calls"},{"title":"Gestionar grupos de WhatsApp","href":"/es/api-reference/guides/whatsapp-platform/manage-whatsapp-groups"}]}]},{"group":"Meta Business Agent","pages":[{"title":"Información general de Meta Business Agent","href":"/es/documentation/meta-business-agent/overview"},{"title":"Preparar y comprobar la elegibilidad","href":"/es/documentation/meta-business-agent/prepare-and-check-eligibility"},{"title":"Incorporación y configuración","href":"/es/documentation/meta-business-agent/onboard-and-configure"},{"title":"Probar y evaluar","href":"/es/documentation/meta-business-agent/test-and-evaluate"},{"title":"Implementación segura","href":"/es/documentation/meta-business-agent/roll-out-safely"},{"title":"Operar y solucionar problemas","href":"/es/documentation/meta-business-agent/operate-and-troubleshoot"}]},{"group":"Datos de clientes y operaciones","pages":[{"title":"Consultar saldo de la cuenta","href":"/es/api-reference/guides/customer-data-and-operations/check-account-balance"},{"title":"Gestionar contactos","href":"/es/api-reference/guides/customer-data-and-operations/manage-contacts"},{"title":"Rastrear eventos personalizados","href":"/es/api-reference/guides/customer-data-and-operations/track-custom-events"},{"title":"Gestionar bajas de suscripción","href":"/es/api-reference/guides/customer-data-and-operations/manage-unsubscribers"}]},{"group":"Ejemplos","pages":[{"title":"Ejemplos de API y Webhook","href":"/es/api-reference/guides/examples/overview"},{"group":"Ejemplos de API","pages":[{"title":"Ejemplos de creación de plantillas de WhatsApp","href":"/es/api-reference/guides/examples/api-examples/whatsapp-template-creation-examples"},{"title":"Ejemplos de mensajería de WhatsApp","href":"/es/api-reference/guides/examples/api-examples/whatsapp-messaging-examples"}]},{"group":"Ejemplos de Webhook","pages":[{"title":"Ejemplos de Webhook","href":"/es/api-reference/guides/examples/webhook-examples/overview"},{"group":"Mensajes","pages":[{"title":"Ejemplos de webhook de estado de mensajes","href":"/es/api-reference/guides/examples/webhook-examples/whatsapp-message-updated-webhook-examples"},{"title":"Ejemplos de Webhook para mensajes entrantes y preferencias","href":"/es/api-reference/guides/examples/webhook-examples/whatsapp-inbound-message-webhook-examples"}]},{"group":"Meta Business Agent","pages":[{"title":"Mensaje de eco de Meta Business Agent creado","sidebarTitle":"Mensaje de eco creado","href":"/es/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created"},{"title":"Mensaje de eco de Meta Business Agent actualizado","sidebarTitle":"Mensaje de eco actualizado","href":"/es/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-updated"},{"title":"Traspaso de control del Meta Business Agent","sidebarTitle":"Traspaso de control","href":"/es/api-reference/guides/examples/webhook-examples/whatsapp-meta-business-agent-handover-updated"}]},{"group":"WhatsApp Business App","pages":[{"title":"Ejemplos de Webhook de mensajes del historial de la aplicación WhatsApp Business","href":"/es/api-reference/guides/examples/webhook-examples/whatsapp-business-app-history-message-webhook-examples"},{"title":"Ejemplos de Webhook para sincronización de mensajes enviados en WhatsApp Business App","href":"/es/api-reference/guides/examples/webhook-examples/whatsapp-business-app-sent-message-sync-webhook-examples"}]},{"group":"Plantillas y cuentas","pages":[{"title":"Ejemplos de webhook para plantillas de WhatsApp","href":"/es/api-reference/guides/examples/webhook-examples/whatsapp-template-reviewed-webhook-examples"},{"title":"Ejemplos de Webhook para cuenta y número de teléfono de WhatsApp","href":"/es/api-reference/guides/examples/webhook-examples/whatsapp-business-account-updated-webhook-examples"}]},{"group":"Llamadas","pages":[{"title":"Ejemplos de Webhook de Calling Connect de WhatsApp","href":"/es/api-reference/guides/examples/webhook-examples/whatsapp-calling-connect-webhook-examples"},{"title":"Ejemplos de Webhook de actualización de estado de llamadas de WhatsApp","href":"/es/api-reference/guides/examples/webhook-examples/whatsapp-calling-status-update-webhook-examples"},{"title":"Ejemplos de Webhook para terminación y captura de llamadas de WhatsApp","href":"/es/api-reference/guides/examples/webhook-examples/whatsapp-calling-terminate-webhook-examples"}]},{"group":"Grupos","pages":[{"title":"Ejemplos de webhook de actualización del ciclo de vida de grupos de WhatsApp","href":"/es/api-reference/guides/examples/webhook-examples/whatsapp-group-lifecycle-update-webhook-examples"},{"title":"Ejemplos de webhook de actualización de participantes de grupos de WhatsApp","href":"/es/api-reference/guides/examples/webhook-examples/whatsapp-group-participants-update-webhook-examples"},{"title":"Ejemplos de Webhook de actualización de configuración de grupos de WhatsApp","href":"/es/api-reference/guides/examples/webhook-examples/whatsapp-group-settings-update-webhook-examples"},{"title":"Ejemplos de webhook de actualización de estado de grupos de WhatsApp","href":"/es/api-reference/guides/examples/webhook-examples/whatsapp-group-status-update-webhook-examples"}]},{"group":"Flows","pages":[{"title":"Ejemplos de webhook de WhatsApp Flow","href":"/es/api-reference/guides/examples/webhook-examples/whatsapp-flow-webhook-examples"}]},{"group":"Pagos","pages":[{"title":"Ejemplos de Webhook de pago de WhatsApp actualizado","href":"/es/api-reference/guides/examples/webhook-examples/whatsapp-payment-updated-webhook-examples"}]},{"group":"Contactos y bajas","pages":[{"title":"Ejemplos de Webhook para creación de contactos y notas","href":"/es/api-reference/guides/examples/webhook-examples/contact-created-webhook-examples"},{"title":"Ejemplos de Webhook para eliminación de contactos y notas","href":"/es/api-reference/guides/examples/webhook-examples/contact-deleted-webhook-examples"},{"title":"Ejemplos de Webhook para actualizaciones de contactos y notas","href":"/es/api-reference/guides/examples/webhook-examples/contact-attributes-changed-webhook-examples"},{"title":"Ejemplos de Webhook de baja de contacto creada","href":"/es/api-reference/guides/examples/webhook-examples/contact-unsubscribe-created-webhook-examples"},{"title":"Ejemplos de Webhook de baja de contacto eliminada","href":"/es/api-reference/guides/examples/webhook-examples/contact-unsubscribe-deleted-webhook-examples"}]},{"title":"Ejemplos de cargas útiles de Webhook","href":"/es/api-reference/guides/examples/webhook-examples/webhook-payload-examples"}]}]}]},{"group":"Endpoints","pages":[{"group":"Cuentas de WhatsApp Business","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":"Mensajes entrantes de WhatsApp","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":"Archivos multimedia de WhatsApp","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":"Mensajes de WhatsApp","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":"Mensajes de Messenger","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":"Usuarios bloqueados de WhatsApp","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":"Grupos de WhatsApp","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":"Llamadas de WhatsApp","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":"Números de teléfono de WhatsApp","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":"Plantillas de WhatsApp","pages":[{"title":"Create a template","description":"Creates a WhatsApp template.\n\nInclude `limited_time_offer` only in a component whose `type` is `LIMITED_TIME_OFFER`. Other component types do not require this object or its `text` field.","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","description":"Returns daily YCloud message metrics and, when available, Meta Template Insights\nfor one WhatsApp template. Authenticate with `X-API-Key`.\n`analyticsStatus` describes Meta Template Insights only; it does not describe YCloud metrics.\nDates are interpreted in the WABA timezone, both boundaries are inclusive, and the range\nmust contain between 1 and 90 calendar days.\n\nThe selected template must currently exist under the requested WABA. REST resolves and\nvalidates the template before querying any statistics. A missing template returns `404`,\na template that belongs to another WABA returns `403`, and a template lookup failure returns\n`500`; none of these errors returns partial statistics.","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":"Saldo","pages":[{"title":"Retrieve balance","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /balance","href":"/api-reference/balance/retrieve-balance"}]},{"group":"Contactos","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":"Eventos personalizados","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":"Correos electrónicos","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":"Usuarios dados de baja","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":"Verificación","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":"Voces","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":"Endpoints de Webhook","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":"Descripción general de Meta Business Agent","href":"/es/api-reference/meta-business-agents/overview"},{"group":"Configurar","pages":[{"group":"Conocimiento del agente: información de la empresa","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":"Conocimiento del agente: preguntas frecuentes","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":"Conocimiento del agente: archivos","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":"Conocimiento del agente: sitios web","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":"Habilidades del agente","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":"Habilidades de interfaz de usuario","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":"Herramientas de conectores","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":"Conectores","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":"Eliminar agente","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":"Incorporación","pages":[{"group":"Lista de permitidos del agente","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":"Elegibilidad del agente","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":"Incorporación de agentes","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":"Configuración del agente","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":"Presupuestos del agente","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":"Operar","pages":[{"group":"Evaluación del agente","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":"Evento del agente","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":"Prueba del agente","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":"Turnos de conversación","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":"Control de hilos (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":"Probar webhooks","sidebarTitle":"Probar webhooks","openapi":"openapi/webhooks/testing-webhooks.yaml POST /webhooks/ycloud","playground":"interactive","href":"/es/api-reference/webhooks/test-webhooks"}]}]},{"tab":"Centro de socios","icon":"handshake","pages":[{"title":"Centro de socios","href":"/es/partner-center/overview"}]}]},{"language":"pt","tabs":[{"tab":"Documentação","icon":"book-open","pages":[{"title":"Documentação","href":"/pt/documentation/overview"}]},{"tab":"Referência da API","icon":"code","groups":[{"group":"Primeiros passos","pages":[{"title":"API da YCloud","href":"/pt/api-reference/getting-started/ycloud-api"},{"title":"Início rápido","href":"/pt/api-reference/getting-started/quickstart"},{"title":"Registro de alterações da API","href":"/pt/api-reference/getting-started/changelog"}]},{"group":"Guias","pages":[{"title":"Guias","href":"/pt/api-reference/guides/overview"},{"group":"Fundamentos da API","pages":[{"title":"Autenticação","href":"/pt/api-reference/guides/api-fundamentals/authentication"},{"title":"Tratar erros","href":"/pt/api-reference/guides/api-fundamentals/handle-errors"},{"title":"Limites de taxa","href":"/pt/api-reference/guides/api-fundamentals/rate-limits"},{"title":"Paginação","href":"/pt/api-reference/guides/api-fundamentals/pagination"},{"title":"Controle de versão e compatibilidade da API","href":"/pt/api-reference/guides/api-fundamentals/versioning"},{"title":"Configurar webhooks","href":"/pt/api-reference/guides/api-fundamentals/configure-webhooks"},{"title":"Implementar um receptor de webhook","href":"/pt/api-reference/guides/api-fundamentals/implement-a-webhook-receiver"}]},{"group":"Plataforma do WhatsApp","pages":[{"group":"Enviar e receber","pages":[{"title":"Enviar uma mensagem do WhatsApp","href":"/pt/api-reference/guides/whatsapp-platform/send-whatsapp-message"},{"title":"Código de erro do WhatsApp","href":"/pt/api-reference/guides/whatsapp-platform/whatsapp-error-code"},{"title":"Gerenciar mensagens recebidas do WhatsApp","href":"/pt/api-reference/guides/whatsapp-platform/handle-whatsapp-inbound-messages"},{"title":"Fazer upload de mídia do WhatsApp","href":"/pt/api-reference/guides/whatsapp-platform/upload-whatsapp-media"},{"title":"Guia de integração de preços de mensagens do WhatsApp","href":"/pt/api-reference/guides/whatsapp-platform/whatsapp-message-pricing-integration-guide"},{"title":"Guia de integração do Preço Máximo","href":"/pt/api-reference/guides/whatsapp-platform/max-price-integration-guide"}]},{"group":"Boas práticas","pages":[{"title":"Melhores práticas da WhatsApp Messages API","href":"/pt/api-reference/guides/whatsapp-platform/whatsapp-messages-api-best-practices"},{"title":"Práticas recomendadas para o Direct Send","href":"/pt/api-reference/guides/whatsapp-platform/best-practices/direct-send"}]},{"group":"Contas comerciais","pages":[{"title":"Gerenciar contas do WhatsApp Business","href":"/pt/api-reference/guides/whatsapp-platform/manage-whatsapp-business-accounts"},{"title":"Gerenciar números de telefone do WhatsApp","href":"/pt/api-reference/guides/whatsapp-platform/manage-whatsapp-phone-numbers"},{"title":"Usar IDs de usuário com escopo de negócios (BSUIDs)","href":"/pt/api-reference/guides/whatsapp-platform/use-business-scoped-user-ids"}]},{"group":"Modelos e fluxos","pages":[{"title":"Gerenciar modelos do WhatsApp","href":"/pt/api-reference/guides/whatsapp-platform/manage-whatsapp-templates"},{"title":"Idiomas de modelo do WhatsApp suportados","href":"/pt/api-reference/guides/whatsapp-platform/supported-whatsapp-template-languages"},{"title":"Gerenciar WhatsApp Flows","href":"/pt/api-reference/guides/whatsapp-platform/manage-whatsapp-flows"},{"title":"Implementar um endpoint de WhatsApp Flow","href":"/pt/api-reference/guides/whatsapp-platform/implement-a-whatsapp-flow-endpoint"}]},{"group":"Chamadas e grupos","pages":[{"title":"Gerenciar chamadas do WhatsApp","href":"/pt/api-reference/guides/whatsapp-platform/manage-whatsapp-calls"},{"title":"Gerenciar grupos do WhatsApp","href":"/pt/api-reference/guides/whatsapp-platform/manage-whatsapp-groups"}]}]},{"group":"Meta Business Agent","pages":[{"title":"Visão geral do Meta Business Agent","href":"/pt/documentation/meta-business-agent/overview"},{"title":"Preparar e verificar a elegibilidade","href":"/pt/documentation/meta-business-agent/prepare-and-check-eligibility"},{"title":"Integrar e configurar","href":"/pt/documentation/meta-business-agent/onboard-and-configure"},{"title":"Testar e avaliar","href":"/pt/documentation/meta-business-agent/test-and-evaluate"},{"title":"Lançamento seguro","href":"/pt/documentation/meta-business-agent/roll-out-safely"},{"title":"Operar e solucionar problemas","href":"/pt/documentation/meta-business-agent/operate-and-troubleshoot"}]},{"group":"Dados e operações de clientes","pages":[{"title":"Consultar saldo da conta","href":"/pt/api-reference/guides/customer-data-and-operations/check-account-balance"},{"title":"Gerenciar contatos","href":"/pt/api-reference/guides/customer-data-and-operations/manage-contacts"},{"title":"Rastrear eventos personalizados","href":"/pt/api-reference/guides/customer-data-and-operations/track-custom-events"},{"title":"Gerenciar cancelamentos de inscrição","href":"/pt/api-reference/guides/customer-data-and-operations/manage-unsubscribers"}]},{"group":"Exemplos","pages":[{"title":"Exemplos de API e Webhook","href":"/pt/api-reference/guides/examples/overview"},{"group":"Exemplos de API","pages":[{"title":"Exemplos de criação de modelos do WhatsApp","href":"/pt/api-reference/guides/examples/api-examples/whatsapp-template-creation-examples"},{"title":"Exemplos de mensagens do WhatsApp","href":"/pt/api-reference/guides/examples/api-examples/whatsapp-messaging-examples"}]},{"group":"Exemplos de Webhook","pages":[{"title":"Exemplos de Webhook","href":"/pt/api-reference/guides/examples/webhook-examples/overview"},{"group":"Mensagens","pages":[{"title":"Exemplos de webhook de status de mensagem","href":"/pt/api-reference/guides/examples/webhook-examples/whatsapp-message-updated-webhook-examples"},{"title":"Exemplos de webhook para mensagens de entrada e preferências","href":"/pt/api-reference/guides/examples/webhook-examples/whatsapp-inbound-message-webhook-examples"}]},{"group":"Meta Business Agent","pages":[{"title":"Mensagem de eco do Meta Business Agent criada","sidebarTitle":"Mensagem de eco criada","href":"/pt/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created"},{"title":"Mensagem de eco do Meta Business Agent atualizada","sidebarTitle":"Mensagem de eco atualizada","href":"/pt/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-updated"},{"title":"Transferência de controle do Meta Business Agent","sidebarTitle":"Transferência de controle","href":"/pt/api-reference/guides/examples/webhook-examples/whatsapp-meta-business-agent-handover-updated"}]},{"group":"WhatsApp Business App","pages":[{"title":"Exemplos de Webhook de Mensagens do Histórico do WhatsApp Business App","href":"/pt/api-reference/guides/examples/webhook-examples/whatsapp-business-app-history-message-webhook-examples"},{"title":"Exemplos de webhook de sincronização de mensagens enviadas do aplicativo WhatsApp Business","href":"/pt/api-reference/guides/examples/webhook-examples/whatsapp-business-app-sent-message-sync-webhook-examples"}]},{"group":"Modelos e contas","pages":[{"title":"Exemplos de webhooks de modelo do WhatsApp","href":"/pt/api-reference/guides/examples/webhook-examples/whatsapp-template-reviewed-webhook-examples"},{"title":"Exemplos de webhook para conta e número de telefone do WhatsApp","href":"/pt/api-reference/guides/examples/webhook-examples/whatsapp-business-account-updated-webhook-examples"}]},{"group":"Chamadas","pages":[{"title":"Exemplos de Webhook de Calling Connect do WhatsApp","href":"/pt/api-reference/guides/examples/webhook-examples/whatsapp-calling-connect-webhook-examples"},{"title":"Exemplos de Webhook de atualização de status de chamada do WhatsApp","href":"/pt/api-reference/guides/examples/webhook-examples/whatsapp-calling-status-update-webhook-examples"},{"title":"Exemplos de webhook de encerramento e captura de chamadas do WhatsApp","href":"/pt/api-reference/guides/examples/webhook-examples/whatsapp-calling-terminate-webhook-examples"}]},{"group":"Grupos","pages":[{"title":"Exemplos de Webhook de Atualização do Ciclo de Vida de Grupos do WhatsApp","href":"/pt/api-reference/guides/examples/webhook-examples/whatsapp-group-lifecycle-update-webhook-examples"},{"title":"Exemplos de Webhook de atualização de participantes do grupo do WhatsApp","href":"/pt/api-reference/guides/examples/webhook-examples/whatsapp-group-participants-update-webhook-examples"},{"title":"Exemplos de Webhook de atualização de configurações de grupo do WhatsApp","href":"/pt/api-reference/guides/examples/webhook-examples/whatsapp-group-settings-update-webhook-examples"},{"title":"Exemplos de Webhook de Atualização de Status de Grupo do WhatsApp","href":"/pt/api-reference/guides/examples/webhook-examples/whatsapp-group-status-update-webhook-examples"}]},{"group":"Flows","pages":[{"title":"Exemplos de Webhook do WhatsApp Flow","href":"/pt/api-reference/guides/examples/webhook-examples/whatsapp-flow-webhook-examples"}]},{"group":"Pagamentos","pages":[{"title":"Exemplos de Webhook de Pagamento Atualizado do WhatsApp","href":"/pt/api-reference/guides/examples/webhook-examples/whatsapp-payment-updated-webhook-examples"}]},{"group":"Contatos e cancelamentos","pages":[{"title":"Exemplos de webhook de criação de contato e anotação","href":"/pt/api-reference/guides/examples/webhook-examples/contact-created-webhook-examples"},{"title":"Exemplos de webhook para exclusão de contatos e notas","href":"/pt/api-reference/guides/examples/webhook-examples/contact-deleted-webhook-examples"},{"title":"Exemplos de webhook para atualização de contato e anotação","href":"/pt/api-reference/guides/examples/webhook-examples/contact-attributes-changed-webhook-examples"},{"title":"Exemplos de Webhook de Cancelamento de Inscrição de Contato Criado","href":"/pt/api-reference/guides/examples/webhook-examples/contact-unsubscribe-created-webhook-examples"},{"title":"Exemplos de Webhook de cancelamento de inscrição de contato excluído","href":"/pt/api-reference/guides/examples/webhook-examples/contact-unsubscribe-deleted-webhook-examples"}]},{"title":"Exemplos de payload de Webhook","href":"/pt/api-reference/guides/examples/webhook-examples/webhook-payload-examples"}]}]}]},{"group":"Endpoints","pages":[{"group":"Contas do WhatsApp Business","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":"Mensagens recebidas do WhatsApp","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":"Mídia do WhatsApp","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":"Mensagens do WhatsApp","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":"Mensagens do Messenger","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":"Usuários bloqueados do WhatsApp","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":"Grupos do WhatsApp","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":"Chamadas do WhatsApp","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":"Números de telefone do WhatsApp","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":"Modelos do WhatsApp","pages":[{"title":"Create a template","description":"Creates a WhatsApp template.\n\nInclude `limited_time_offer` only in a component whose `type` is `LIMITED_TIME_OFFER`. Other component types do not require this object or its `text` field.","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","description":"Returns daily YCloud message metrics and, when available, Meta Template Insights\nfor one WhatsApp template. Authenticate with `X-API-Key`.\n`analyticsStatus` describes Meta Template Insights only; it does not describe YCloud metrics.\nDates are interpreted in the WABA timezone, both boundaries are inclusive, and the range\nmust contain between 1 and 90 calendar days.\n\nThe selected template must currently exist under the requested WABA. REST resolves and\nvalidates the template before querying any statistics. A missing template returns `404`,\na template that belongs to another WABA returns `403`, and a template lookup failure returns\n`500`; none of these errors returns partial statistics.","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":"Saldo","pages":[{"title":"Retrieve balance","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /balance","href":"/api-reference/balance/retrieve-balance"}]},{"group":"Contatos","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":"Eventos personalizados","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":"E-mails","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":"Usuários cancelados","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":"Verificação","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":"Vozes","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":"Endpoints de Webhook","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":"Visão geral do Meta Business Agent","href":"/pt/api-reference/meta-business-agents/overview"},{"group":"Configurar","pages":[{"group":"Base de conhecimento do agente - Informações da empresa","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":"Base de conhecimento do agente - Perguntas frequentes","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":"Base de conhecimento do agente - Arquivos","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":"Base de conhecimento do agente - Sites","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":"Habilidades do agente","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":"Habilidades de interface","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":"Ferramentas de conectores","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":"Conectores","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":"Excluir agente","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":"Integrar","pages":[{"group":"Lista de permissões do agente","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":"Elegibilidade do agente","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":"Integração do agente","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":"Configurações do agente","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":"Orçamentos do agente","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":"Operar","pages":[{"group":"Avaliação do agente","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":"Evento do agente","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":"Teste do agente","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":"Turnos de conversa","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":"Controle de conversas (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":"Testar webhooks","sidebarTitle":"Testar webhooks","openapi":"openapi/webhooks/testing-webhooks.yaml POST /webhooks/ycloud","playground":"interactive","href":"/pt/api-reference/webhooks/test-webhooks"}]}]},{"tab":"Central de parceiros","icon":"handshake","pages":[{"title":"Central de parceiros","href":"/pt/partner-center/overview"}]}]},{"language":"ru","tabs":[{"tab":"Документация","icon":"book-open","pages":[{"title":"Документация","href":"/ru/documentation/overview"}]},{"tab":"Справочник API","icon":"code","groups":[{"group":"Начало работы","pages":[{"title":"YCloud API","href":"/ru/api-reference/getting-started/ycloud-api"},{"title":"Быстрый старт","href":"/ru/api-reference/getting-started/quickstart"},{"title":"Журнал изменений API","href":"/ru/api-reference/getting-started/changelog"}]},{"group":"Руководства","pages":[{"title":"Руководства","href":"/ru/api-reference/guides/overview"},{"group":"Основы API","pages":[{"title":"Аутентификация","href":"/ru/api-reference/guides/api-fundamentals/authentication"},{"title":"Обработка ошибок","href":"/ru/api-reference/guides/api-fundamentals/handle-errors"},{"title":"Ограничения частоты запросов","href":"/ru/api-reference/guides/api-fundamentals/rate-limits"},{"title":"Пагинация","href":"/ru/api-reference/guides/api-fundamentals/pagination"},{"title":"Версионирование и совместимость API","href":"/ru/api-reference/guides/api-fundamentals/versioning"},{"title":"Настройка вебхуков","href":"/ru/api-reference/guides/api-fundamentals/configure-webhooks"},{"title":"Реализация получателя Webhook","href":"/ru/api-reference/guides/api-fundamentals/implement-a-webhook-receiver"}]},{"group":"Платформа WhatsApp","pages":[{"group":"Отправка и получение","pages":[{"title":"Отправка сообщения WhatsApp","href":"/ru/api-reference/guides/whatsapp-platform/send-whatsapp-message"},{"title":"Коды ошибок WhatsApp","href":"/ru/api-reference/guides/whatsapp-platform/whatsapp-error-code"},{"title":"Обработка входящих сообщений WhatsApp","href":"/ru/api-reference/guides/whatsapp-platform/handle-whatsapp-inbound-messages"},{"title":"Загрузка медиафайлов WhatsApp","href":"/ru/api-reference/guides/whatsapp-platform/upload-whatsapp-media"},{"title":"Руководство по интеграции тарификации сообщений WhatsApp","href":"/ru/api-reference/guides/whatsapp-platform/whatsapp-message-pricing-integration-guide"},{"title":"Руководство по интеграции Max Price","href":"/ru/api-reference/guides/whatsapp-platform/max-price-integration-guide"}]},{"group":"Рекомендации","pages":[{"title":"Рекомендации по API сообщений WhatsApp","href":"/ru/api-reference/guides/whatsapp-platform/whatsapp-messages-api-best-practices"},{"title":"Практические рекомендации по Direct Send","href":"/ru/api-reference/guides/whatsapp-platform/best-practices/direct-send"}]},{"group":"Бизнес-аккаунты","pages":[{"title":"Управление аккаунтами WhatsApp Business","href":"/ru/api-reference/guides/whatsapp-platform/manage-whatsapp-business-accounts"},{"title":"Управление номерами телефонов WhatsApp","href":"/ru/api-reference/guides/whatsapp-platform/manage-whatsapp-phone-numbers"},{"title":"Использование business-scoped user ID","href":"/ru/api-reference/guides/whatsapp-platform/use-business-scoped-user-ids"}]},{"group":"Шаблоны и сценарии","pages":[{"title":"Управление шаблонами WhatsApp","href":"/ru/api-reference/guides/whatsapp-platform/manage-whatsapp-templates"},{"title":"Поддерживаемые языки шаблонов WhatsApp","href":"/ru/api-reference/guides/whatsapp-platform/supported-whatsapp-template-languages"},{"title":"Управление WhatsApp Flows","href":"/ru/api-reference/guides/whatsapp-platform/manage-whatsapp-flows"},{"title":"Реализация эндпоинта WhatsApp Flow","href":"/ru/api-reference/guides/whatsapp-platform/implement-a-whatsapp-flow-endpoint"}]},{"group":"Звонки и группы","pages":[{"title":"Управление звонками WhatsApp","href":"/ru/api-reference/guides/whatsapp-platform/manage-whatsapp-calls"},{"title":"Управление группами WhatsApp","href":"/ru/api-reference/guides/whatsapp-platform/manage-whatsapp-groups"}]}]},{"group":"Meta Business Agent","pages":[{"title":"Обзор Meta Business Agent","href":"/ru/documentation/meta-business-agent/overview"},{"title":"Подготовка и проверка соответствия требованиям","href":"/ru/documentation/meta-business-agent/prepare-and-check-eligibility"},{"title":"Подключение и настройка","href":"/ru/documentation/meta-business-agent/onboard-and-configure"},{"title":"Тестирование и оценка","href":"/ru/documentation/meta-business-agent/test-and-evaluate"},{"title":"Безопасное развертывание","href":"/ru/documentation/meta-business-agent/roll-out-safely"},{"title":"Эксплуатация и устранение неполадок","href":"/ru/documentation/meta-business-agent/operate-and-troubleshoot"}]},{"group":"Данные клиентов и операции","pages":[{"title":"Проверка баланса аккаунта","href":"/ru/api-reference/guides/customer-data-and-operations/check-account-balance"},{"title":"Управление контактами","href":"/ru/api-reference/guides/customer-data-and-operations/manage-contacts"},{"title":"Отслеживание пользовательских событий","href":"/ru/api-reference/guides/customer-data-and-operations/track-custom-events"},{"title":"Управление отписавшимися пользователями","href":"/ru/api-reference/guides/customer-data-and-operations/manage-unsubscribers"}]},{"group":"Примеры","pages":[{"title":"Примеры API и Webhook","href":"/ru/api-reference/guides/examples/overview"},{"group":"Примеры API","pages":[{"title":"Примеры создания шаблонов WhatsApp","href":"/ru/api-reference/guides/examples/api-examples/whatsapp-template-creation-examples"},{"title":"Примеры сообщений WhatsApp","href":"/ru/api-reference/guides/examples/api-examples/whatsapp-messaging-examples"}]},{"group":"Примеры Webhook","pages":[{"title":"Примеры Webhook","href":"/ru/api-reference/guides/examples/webhook-examples/overview"},{"group":"Сообщения","pages":[{"title":"Примеры Webhook для статусов сообщений","href":"/ru/api-reference/guides/examples/webhook-examples/whatsapp-message-updated-webhook-examples"},{"title":"Примеры Webhook для входящих сообщений и маркетинговых предпочтений","href":"/ru/api-reference/guides/examples/webhook-examples/whatsapp-inbound-message-webhook-examples"}]},{"group":"Meta Business Agent","pages":[{"title":"Создано эхо-сообщение Meta Business Agent","sidebarTitle":"Эхо-сообщение создано","href":"/ru/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created"},{"title":"Эхо-сообщение Meta Business Agent обновлено","sidebarTitle":"Эхо-сообщение обновлено","href":"/ru/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-updated"},{"title":"Передача управления Meta Business Agent","sidebarTitle":"Передача управления","href":"/ru/api-reference/guides/examples/webhook-examples/whatsapp-meta-business-agent-handover-updated"}]},{"group":"WhatsApp Business App","pages":[{"title":"Примеры Webhook для сообщений из истории WhatsApp Business App","href":"/ru/api-reference/guides/examples/webhook-examples/whatsapp-business-app-history-message-webhook-examples"},{"title":"Примеры Webhook для синхронизации отправленных сообщений WhatsApp Business App","href":"/ru/api-reference/guides/examples/webhook-examples/whatsapp-business-app-sent-message-sync-webhook-examples"}]},{"group":"Шаблоны и аккаунты","pages":[{"title":"Примеры вебхуков для шаблонов WhatsApp","href":"/ru/api-reference/guides/examples/webhook-examples/whatsapp-template-reviewed-webhook-examples"},{"title":"Примеры вебхуков для аккаунтов и номеров телефонов WhatsApp","href":"/ru/api-reference/guides/examples/webhook-examples/whatsapp-business-account-updated-webhook-examples"}]},{"group":"Звонки","pages":[{"title":"Примеры Webhook для соединения вызовов WhatsApp Calling Connect","href":"/ru/api-reference/guides/examples/webhook-examples/whatsapp-calling-connect-webhook-examples"},{"title":"Примеры Webhook для обновления статуса звонков WhatsApp","href":"/ru/api-reference/guides/examples/webhook-examples/whatsapp-calling-status-update-webhook-examples"},{"title":"Примеры Webhook завершения и фиксации звонков WhatsApp","href":"/ru/api-reference/guides/examples/webhook-examples/whatsapp-calling-terminate-webhook-examples"}]},{"group":"Группы","pages":[{"title":"Примеры Webhook для обновления жизненного цикла групп WhatsApp","href":"/ru/api-reference/guides/examples/webhook-examples/whatsapp-group-lifecycle-update-webhook-examples"},{"title":"Примеры Webhook для обновлений участников групп WhatsApp","href":"/ru/api-reference/guides/examples/webhook-examples/whatsapp-group-participants-update-webhook-examples"},{"title":"Примеры вебхуков обновления настроек группы WhatsApp","href":"/ru/api-reference/guides/examples/webhook-examples/whatsapp-group-settings-update-webhook-examples"},{"title":"Примеры Webhook для обновления статуса группы WhatsApp","href":"/ru/api-reference/guides/examples/webhook-examples/whatsapp-group-status-update-webhook-examples"}]},{"group":"Flows","pages":[{"title":"Примеры вебхуков для WhatsApp Flow","href":"/ru/api-reference/guides/examples/webhook-examples/whatsapp-flow-webhook-examples"}]},{"group":"Платежи","pages":[{"title":"Примеры Webhook для обновления платежей WhatsApp","href":"/ru/api-reference/guides/examples/webhook-examples/whatsapp-payment-updated-webhook-examples"}]},{"group":"Контакты и отписки","pages":[{"title":"Примеры Webhook для создания контактов и заметок","href":"/ru/api-reference/guides/examples/webhook-examples/contact-created-webhook-examples"},{"title":"Примеры Webhook при удалении контактов и заметок","href":"/ru/api-reference/guides/examples/webhook-examples/contact-deleted-webhook-examples"},{"title":"Примеры Webhook для обновлений контакта и заметок","href":"/ru/api-reference/guides/examples/webhook-examples/contact-attributes-changed-webhook-examples"},{"title":"Примеры Webhook: создание отписки контакта","href":"/ru/api-reference/guides/examples/webhook-examples/contact-unsubscribe-created-webhook-examples"},{"title":"Примеры Webhook: Contact Unsubscribe Deleted","href":"/ru/api-reference/guides/examples/webhook-examples/contact-unsubscribe-deleted-webhook-examples"}]},{"title":"Примеры полезных нагрузок Webhook","href":"/ru/api-reference/guides/examples/webhook-examples/webhook-payload-examples"}]}]}]},{"group":"Конечные точки","pages":[{"group":"Аккаунты WhatsApp Business","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","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","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","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","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","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","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","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","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","pages":[{"title":"Create a template","description":"Creates a WhatsApp template.\n\nInclude `limited_time_offer` only in a component whose `type` is `LIMITED_TIME_OFFER`. Other component types do not require this object or its `text` field.","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","description":"Returns daily YCloud message metrics and, when available, Meta Template Insights\nfor one WhatsApp template. Authenticate with `X-API-Key`.\n`analyticsStatus` describes Meta Template Insights only; it does not describe YCloud metrics.\nDates are interpreted in the WABA timezone, both boundaries are inclusive, and the range\nmust contain between 1 and 90 calendar days.\n\nThe selected template must currently exist under the requested WABA. REST resolves and\nvalidates the template before querying any statistics. A missing template returns `404`,\na template that belongs to another WABA returns `403`, and a template lookup failure returns\n`500`; none of these errors returns partial statistics.","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":"Баланс","pages":[{"title":"Retrieve balance","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /balance","href":"/api-reference/balance/retrieve-balance"}]},{"group":"Контакты","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":"Пользовательские события","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":"Email-сообщения","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":"Отписавшиеся","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":"Верификация","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":"Голоса","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","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","href":"/ru/api-reference/meta-business-agents/overview"},{"group":"Настройка","pages":[{"group":"База знаний агента — Информация о бизнесе","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":"База знаний агента — Часто задаваемые вопросы","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":"База знаний агента — Файлы","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":"База знаний агента — Веб-сайты","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":"Навыки агента","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","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":"Инструменты коннекторов","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":"Коннекторы","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":"Удалить агента","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":"Подключение","pages":[{"group":"Белый список агента","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":"Критерии доступа агента","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":"Онбординг агента","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":"Настройки агента","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":"Бюджеты агента","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":"Управление","pages":[{"group":"Оценка агента","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":"Событие агента","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":"Тестирование агента","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":"Реплики диалога","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":"Управление цепочками диалогов (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":"Тестирование вебхуков","sidebarTitle":"Тестирование вебхуков","openapi":"openapi/webhooks/testing-webhooks.yaml POST /webhooks/ycloud","playground":"interactive","href":"/ru/api-reference/webhooks/test-webhooks"}]}]},{"tab":"Партнерский центр","icon":"handshake","pages":[{"title":"Партнерский центр","href":"/ru/partner-center/overview"}]}]}]},"title":"List templates - YCloud Docs","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}