Use your connected Facebook Page to send a one-to-one text reply.
Meta determines reply eligibility; YCloud does not precheck the messaging window.
Use a Tenant API Key. Developer App API Keys are not supported.
Each call submits a new message. If a timeout occurs or you receive
502 MESSENGER_MESSAGE_RESULT_UNKNOWN, Meta may still have accepted the message.
Do not automatically resubmit it. Check the saved message status using a returned
YCloud or Meta message ID when available, or contact support to investigate.
The Facebook Page ID; not an authorization-record ID or phone number.
Required string length: 1 - 64
to
string
required
Recipient PSID scoped to the specified Page; do not substitute a global Facebook ID.
Required string length: 1 - 64
type
enum<string>
required
Available options:
text
text
object
required
Show child attributes
Response
Meta has accepted the submission. This receipt does not assert delivery
or the record's current status.
id
string
required
The local outbound recordId, serialized as a decimal string.
metaMessageId
string
required
The confirmed Meta message ID.
from
string
required
to
string
required
status
enum<string>
required
Submission receipt only; retrieve the record for its current state.
Available options:
accepted
{"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":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6afaed6f988193f8780429e5","clientVersion":"0.0.4160","searchFilterCounts":[{"language":"en","tag":"Documentation","count":245},{"language":"es","tag":"Documentación","count":244},{"language":"pt","tag":"Documentação","count":244},{"language":"ru","tag":"Документация","count":244},{"language":"zh","tag":"产品文档","count":244},{"language":"default","tag":"API Reference","count":168},{"language":"default","tag":"Endpoints","count":168},{"language":"en","tag":"API Reference","count":91},{"language":"es","tag":"Referencia de la API","count":91},{"language":"pt","tag":"Referência da API","count":91},{"language":"ru","tag":"Справочник API","count":91},{"language":"zh","tag":"API 参考","count":91},{"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":"Webhook reference","count":47},{"language":"es","tag":"Webhook reference","count":47},{"language":"pt","tag":"Webhook reference","count":47},{"language":"ru","tag":"Webhook reference","count":47},{"language":"zh","tag":"Webhook reference","count":47},{"language":"en","tag":"Integrations","count":43},{"language":"es","tag":"Integraciones","count":43},{"language":"pt","tag":"Integrações","count":43},{"language":"ru","tag":"Интеграции","count":43},{"language":"zh","tag":"集成","count":43},{"language":"default","tag":"Configure","count":43},{"language":"en","tag":"WhatsApp Business Platform","count":41},{"language":"es","tag":"WhatsApp Business Platform","count":41},{"language":"pt","tag":"WhatsApp Business Platform","count":41},{"language":"ru","tag":"Платформа WhatsApp Business","count":41},{"language":"zh","tag":"WhatsApp 商业平台","count":41},{"language":"en","tag":"Guides","count":39},{"language":"es","tag":"Guías","count":39},{"language":"pt","tag":"Guias","count":39},{"language":"ru","tag":"Руководства","count":39},{"language":"zh","tag":"指南","count":39},{"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":"WhatsApp Accounts Management","count":28},{"language":"en","tag":"Agents","count":26},{"language":"es","tag":"Agentes","count":26},{"language":"pt","tag":"Agentes","count":26},{"language":"ru","tag":"Агенты","count":26},{"language":"zh","tag":"智能体","count":26},{"language":"en","tag":"Inbox","count":20},{"language":"es","tag":"Bandeja de entrada","count":20},{"language":"pt","tag":"Caixa de entrada","count":20},{"language":"ru","tag":"Входящие","count":20},{"language":"zh","tag":"收件箱","count":20},{"language":"default","tag":"WhatsApp Phone Numbers","count":16},{"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":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/messenger-messages/send-a-messenger-text-reply-directly","slug":"/api-reference/messenger-messages/send-a-messenger-text-reply-directly","pageMetadata":{"title":"Send a Messenger text reply directly","description":"Use your connected Facebook Page to send a one-to-one text reply.\nMeta determines reply eligibility; YCloud does not precheck the messaging window.\nUse a Tenant API Key. Developer App API Keys are not supported.\n\nEach call submits a new message. If a timeout occurs or you receive\n502 MESSENGER_MESSAGE_RESULT_UNKNOWN, Meta may still have accepted the message.\nDo not automatically resubmit it. Check the saved message status using a returned\nYCloud or Meta message ID when available, or contact support to investigate.\n","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","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 p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Use your connected Facebook Page to send a one-to-one text reply.\\nMeta determines reply eligibility; YCloud does not precheck the messaging window.\\nUse a Tenant API Key. Developer App API Keys are not supported.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Each call submits a new message. If a timeout occurs or you receive\\n502 MESSENGER_MESSAGE_RESULT_UNKNOWN, Meta may still have accepted the message.\\nDo not automatically resubmit it. Check the saved message status using a returned\\nYCloud or Meta message ID when available, or contact support to investigate.\"\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":"Send a Messenger text reply directly","description":"Use your connected Facebook Page to send a one-to-one text reply.\nMeta determines reply eligibility; YCloud does not precheck the messaging window.\nUse a Tenant API Key. Developer App API Keys are not supported.\n\nEach call submits a new message. If a timeout occurs or you receive\n502 MESSENGER_MESSAGE_RESULT_UNKNOWN, Meta may still have accepted the message.\nDo not automatically resubmit it. Check the saved message status using a returned\nYCloud or Meta message ID when available, or contact support to investigate.\n","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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Messenger Messages"],"summary":"Send a Messenger text reply directly","operationId":"messenger_message-send-directly","description":"Use your connected Facebook Page to send a one-to-one text reply.\nMeta determines reply eligibility; YCloud does not precheck the messaging window.\nUse a Tenant API Key. Developer App API Keys are not supported.\n\nEach call submits a new message. If a timeout occurs or you receive\n502 MESSENGER_MESSAGE_RESULT_UNKNOWN, Meta may still have accepted the message.\nDo not automatically resubmit it. Check the saved message status using a returned\nYCloud or Meta message ID when available, or contact support to investigate.\n","requestBody":"3cb54353-3a12-4564-b9a6-fdd0b931e16c","responses":{"200":"5e8c4298-7649-4386-9441-cdad73f7ab51","400":"6ac4ca3a-42c8-4761-b063-53c3e18e5ced","401":"db32ac48-777f-4600-92dd-a6a5f4c84bb0","403":"4ef16be7-483d-4af2-be8f-8d567c21d23a","404":"f28cc001-0f34-46bb-a057-17c6c91bb540","429":"c1d83a4a-bff7-4393-ae98-88ac8363b796","500":"41f32582-76e3-4364-8be9-b01b4bccec57","502":"fdb47869-3007-42fc-8d7d-07d842eeedf7"},"method":"post","type":"path","servers":["0c746aad-c516-48bc-b122-f236a679949c"],"security":["7503a75c-64b3-4782-8bfc-d29e73d70610"],"path":"/messenger/messages/sendDirectly","baseUrlOptions":["https://api.ycloud.com/v2"],"title":"Send a Messenger text reply directly","codeSamples":[],"requiredOnlyExamples":true,"disableCodeSampleGeneration":true,"responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.from":"422500000000000","body.to":"100800000000000","body.type":"text","body.text.body":"Hello, how can I help you?"}],"urlDisplay":"full"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["from","to","type","text"],"properties":{"from":{"type":"string","minLength":1,"maxLength":64,"description":"The Facebook Page ID; not an authorization-record ID or phone number.","isRequired":true,"uniqueKey":"from","typeLabel":"string"},"to":{"type":"string","minLength":1,"maxLength":64,"description":"Recipient PSID scoped to the specified Page; do not substitute a global Facebook ID.","isRequired":true,"uniqueKey":"to","typeLabel":"string"},"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"text":{"type":"object","required":["body"],"properties":{"body":{"type":"string","minLength":1,"description":"Nonblank text. Leading and trailing spaces are preserved.","isRequired":true,"uniqueKey":"text.body","typeLabel":"string"}},"isRequired":true,"uniqueKey":"text","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"from":"422500000000000","to":"100800000000000","type":"text","text":{"body":"Hello, how can I help you?"}},"examples":{"Example":{"title":"Example","value":{"from":"422500000000000","to":"100800000000000","type":"text","text":{"body":"Hello, how can I help you?"}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"5e8c4298-7649-4386-9441-cdad73f7ab51":{"description":"Meta has accepted the submission. This receipt does not assert delivery\nor the record's current status.\n","headers":{"YCloud-Request-ID":{"description":"Server-generated HTTP request identifier for troubleshooting.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["id","metaMessageId","from","to","status"],"properties":{"id":{"type":"string","description":"The local outbound recordId, serialized as a decimal string.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"metaMessageId":{"type":"string","description":"The confirmed Meta message ID.","isRequired":true,"uniqueKey":"metaMessageId","typeLabel":"string"},"from":{"type":"string","isRequired":true,"uniqueKey":"from","typeLabel":"string"},"to":{"type":"string","isRequired":true,"uniqueKey":"to","typeLabel":"string"},"status":{"type":"string","enum":["accepted"],"description":"Submission receipt only; retrieve the record for its current state.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"1308528868252065792","metaMessageId":"m_SAMPLE_001","from":"422500000000000","to":"100800000000000","status":"accepted"},"examples":{"Example":{"title":"Example","value":{"id":"1308528868252065792","metaMessageId":"m_SAMPLE_001","from":"422500000000000","to":"100800000000000","status":"accepted"}}},"exampleType":"examples"}},"exampleType":"examples"},"6ac4ca3a-42c8-4761-b063-53c3e18e5ced":{"description":"400 PARAM_MISSING, PARAM_INVALID, PARAM_INVALID_LENGTH or BAD_REQUEST.\nA confirmed Meta refusal maps to BAD_REQUEST and does not trigger automatic resubmission.\nWhen numeric provider diagnostics are available, error.messengerApiError contains\nthe Meta code and optional subcode. The message provides a categorized hint;\nraw provider error text is not returned.\n","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","code"],"properties":{"status":{"type":"integer","format":"int32","pattern":"[45]\\d{2}","description":"HTTP status code, [RFC 7231, Section 6](https://datatracker.ietf.org/doc/html/rfc7231#section-6). It conveys the HTTP status code used for the convenience of the consumer.","example":404,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer\u003cint32>"},"code":{"type":"string","description":"One of a server-defined error codes. Some `4xx` errors that could be handled programmatically include an error code that briefly explains the error reported.","example":"NOT_FOUND","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable representation of the error. It is intended as an aid to developers and is not suitable for exposure to end users.","example":"The requested resource does not exist.","uniqueKey":"error.message","typeLabel":"string"},"target":{"type":"string","description":"The target of the error.","example":"","uniqueKey":"error.target","typeLabel":"string"},"docUrl":{"type":"string","description":"A URL to more information about the error.","example":"","uniqueKey":"error.docUrl","typeLabel":"string"},"requestId":{"type":"string","description":"Each API request has an associated request ID. It conveys the response header `YCloud-Request-ID` used for the convenience of the consumer.","example":"req_1KjtKI80IKoaJNa6n6p","uniqueKey":"error.requestId","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).\n\nNote: This field is returned if we tried to request the WhatsApp Business API and got an error response.","required":["message","code"],"properties":{"message":{"type":"string","description":"A human-readable description of the error.","example":"HSM Template creation failed","isRequired":true,"uniqueKey":"error.whatsappApiError.message","typeLabel":"string"},"code":{"type":"string","description":"An error code.","example":200002,"isRequired":true,"uniqueKey":"error.whatsappApiError.code","typeLabel":"string"},"type":{"type":"string","description":"Error type.","example":"OAuthException","uniqueKey":"error.whatsappApiError.type","typeLabel":"string"},"is_transient":{"type":"boolean","description":"Whether the error is transient.","example":false,"uniqueKey":"error.whatsappApiError.is_transient","typeLabel":"boolean"},"error_subcode":{"type":"string","description":"Additional code about the error.","example":2388109,"uniqueKey":"error.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":"error.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":"error.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":"error.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":"error.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":"error.whatsappApiError.error_data.oneOf.1","typeLabel":"object"}],"uniqueKey":"error.whatsappApiError.error_data","typeLabel":"string | object"}},"uniqueKey":"error.whatsappApiError","typeLabel":"object"},"metaBusinessAgentApiError":{"type":"object","description":"Sanitized upstream details returned when a Meta Business Agent request fails.","properties":{"title":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.title","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.detail","typeLabel":"string"},"type":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.type","typeLabel":"string"},"status":{"type":"integer","format":"int32","uniqueKey":"error.metaBusinessAgentApiError.status","typeLabel":"integer\u003cint32>"},"requestId":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.requestId","typeLabel":"string"}},"uniqueKey":"error.metaBusinessAgentApiError","typeLabel":"object"},"messengerApiError":{"type":"object","description":"Numeric Meta diagnostics for a confirmed Messenger submission refusal. Omitted when unavailable.","required":["code"],"properties":{"code":{"type":"string","description":"Meta error code, encoded as a string.","example":"100","isRequired":true,"uniqueKey":"error.messengerApiError.code","typeLabel":"string"},"subcode":{"type":"string","description":"Meta error subcode, encoded as a string. Omitted if Meta did not provide it.","example":"2018276","uniqueKey":"error.messengerApiError.subcode","typeLabel":"string"}},"uniqueKey":"error.messengerApiError","typeLabel":"object"}},"description":"Contains the error code and human-readable message for the API error.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"status":404,"code":"NOT_FOUND","message":"The requested resource does not exist.","target":"","docUrl":"","requestId":"req_1KjtKI80IKoaJNa6n6p","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>"},"metaBusinessAgentApiError":{"title":"\u003cstring>","detail":"\u003cstring>","type":"\u003cstring>","status":123,"requestId":"\u003cstring>"},"messengerApiError":{"code":"100","subcode":"2018276"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"db32ac48-777f-4600-92dd-a6a5f4c84bb0":{"description":"Existing API-key authentication failure (401 UNAUTHORIZED).","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","code"],"properties":{"status":{"type":"integer","format":"int32","pattern":"[45]\\d{2}","description":"HTTP status code, [RFC 7231, Section 6](https://datatracker.ietf.org/doc/html/rfc7231#section-6). It conveys the HTTP status code used for the convenience of the consumer.","example":404,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer\u003cint32>"},"code":{"type":"string","description":"One of a server-defined error codes. Some `4xx` errors that could be handled programmatically include an error code that briefly explains the error reported.","example":"NOT_FOUND","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable representation of the error. It is intended as an aid to developers and is not suitable for exposure to end users.","example":"The requested resource does not exist.","uniqueKey":"error.message","typeLabel":"string"},"target":{"type":"string","description":"The target of the error.","example":"","uniqueKey":"error.target","typeLabel":"string"},"docUrl":{"type":"string","description":"A URL to more information about the error.","example":"","uniqueKey":"error.docUrl","typeLabel":"string"},"requestId":{"type":"string","description":"Each API request has an associated request ID. It conveys the response header `YCloud-Request-ID` used for the convenience of the consumer.","example":"req_1KjtKI80IKoaJNa6n6p","uniqueKey":"error.requestId","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).\n\nNote: This field is returned if we tried to request the WhatsApp Business API and got an error response.","required":["message","code"],"properties":{"message":{"type":"string","description":"A human-readable description of the error.","example":"HSM Template creation failed","isRequired":true,"uniqueKey":"error.whatsappApiError.message","typeLabel":"string"},"code":{"type":"string","description":"An error code.","example":200002,"isRequired":true,"uniqueKey":"error.whatsappApiError.code","typeLabel":"string"},"type":{"type":"string","description":"Error type.","example":"OAuthException","uniqueKey":"error.whatsappApiError.type","typeLabel":"string"},"is_transient":{"type":"boolean","description":"Whether the error is transient.","example":false,"uniqueKey":"error.whatsappApiError.is_transient","typeLabel":"boolean"},"error_subcode":{"type":"string","description":"Additional code about the error.","example":2388109,"uniqueKey":"error.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":"error.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":"error.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":"error.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":"error.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":"error.whatsappApiError.error_data.oneOf.1","typeLabel":"object"}],"uniqueKey":"error.whatsappApiError.error_data","typeLabel":"string | object"}},"uniqueKey":"error.whatsappApiError","typeLabel":"object"},"metaBusinessAgentApiError":{"type":"object","description":"Sanitized upstream details returned when a Meta Business Agent request fails.","properties":{"title":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.title","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.detail","typeLabel":"string"},"type":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.type","typeLabel":"string"},"status":{"type":"integer","format":"int32","uniqueKey":"error.metaBusinessAgentApiError.status","typeLabel":"integer\u003cint32>"},"requestId":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.requestId","typeLabel":"string"}},"uniqueKey":"error.metaBusinessAgentApiError","typeLabel":"object"},"messengerApiError":{"type":"object","description":"Numeric Meta diagnostics for a confirmed Messenger submission refusal. Omitted when unavailable.","required":["code"],"properties":{"code":{"type":"string","description":"Meta error code, encoded as a string.","example":"100","isRequired":true,"uniqueKey":"error.messengerApiError.code","typeLabel":"string"},"subcode":{"type":"string","description":"Meta error subcode, encoded as a string. Omitted if Meta did not provide it.","example":"2018276","uniqueKey":"error.messengerApiError.subcode","typeLabel":"string"}},"uniqueKey":"error.messengerApiError","typeLabel":"object"}},"description":"Contains the error code and human-readable message for the API error.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"status":404,"code":"NOT_FOUND","message":"The requested resource does not exist.","target":"","docUrl":"","requestId":"req_1KjtKI80IKoaJNa6n6p","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>"},"metaBusinessAgentApiError":{"title":"\u003cstring>","detail":"\u003cstring>","type":"\u003cstring>","status":123,"requestId":"\u003cstring>"},"messengerApiError":{"code":"100","subcode":"2018276"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"4ef16be7-483d-4af2-be8f-8d567c21d23a":{"description":"403 FORBIDDEN. Includes unavailable channel/new-send authorization and unsupported\ndeveloper app API keys. Does not block historical record reads merely because a Page is disconnected.\n","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","code"],"properties":{"status":{"type":"integer","format":"int32","pattern":"[45]\\d{2}","description":"HTTP status code, [RFC 7231, Section 6](https://datatracker.ietf.org/doc/html/rfc7231#section-6). It conveys the HTTP status code used for the convenience of the consumer.","example":404,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer\u003cint32>"},"code":{"type":"string","description":"One of a server-defined error codes. Some `4xx` errors that could be handled programmatically include an error code that briefly explains the error reported.","example":"NOT_FOUND","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable representation of the error. It is intended as an aid to developers and is not suitable for exposure to end users.","example":"The requested resource does not exist.","uniqueKey":"error.message","typeLabel":"string"},"target":{"type":"string","description":"The target of the error.","example":"","uniqueKey":"error.target","typeLabel":"string"},"docUrl":{"type":"string","description":"A URL to more information about the error.","example":"","uniqueKey":"error.docUrl","typeLabel":"string"},"requestId":{"type":"string","description":"Each API request has an associated request ID. It conveys the response header `YCloud-Request-ID` used for the convenience of the consumer.","example":"req_1KjtKI80IKoaJNa6n6p","uniqueKey":"error.requestId","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).\n\nNote: This field is returned if we tried to request the WhatsApp Business API and got an error response.","required":["message","code"],"properties":{"message":{"type":"string","description":"A human-readable description of the error.","example":"HSM Template creation failed","isRequired":true,"uniqueKey":"error.whatsappApiError.message","typeLabel":"string"},"code":{"type":"string","description":"An error code.","example":200002,"isRequired":true,"uniqueKey":"error.whatsappApiError.code","typeLabel":"string"},"type":{"type":"string","description":"Error type.","example":"OAuthException","uniqueKey":"error.whatsappApiError.type","typeLabel":"string"},"is_transient":{"type":"boolean","description":"Whether the error is transient.","example":false,"uniqueKey":"error.whatsappApiError.is_transient","typeLabel":"boolean"},"error_subcode":{"type":"string","description":"Additional code about the error.","example":2388109,"uniqueKey":"error.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":"error.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":"error.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":"error.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":"error.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":"error.whatsappApiError.error_data.oneOf.1","typeLabel":"object"}],"uniqueKey":"error.whatsappApiError.error_data","typeLabel":"string | object"}},"uniqueKey":"error.whatsappApiError","typeLabel":"object"},"metaBusinessAgentApiError":{"type":"object","description":"Sanitized upstream details returned when a Meta Business Agent request fails.","properties":{"title":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.title","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.detail","typeLabel":"string"},"type":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.type","typeLabel":"string"},"status":{"type":"integer","format":"int32","uniqueKey":"error.metaBusinessAgentApiError.status","typeLabel":"integer\u003cint32>"},"requestId":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.requestId","typeLabel":"string"}},"uniqueKey":"error.metaBusinessAgentApiError","typeLabel":"object"},"messengerApiError":{"type":"object","description":"Numeric Meta diagnostics for a confirmed Messenger submission refusal. Omitted when unavailable.","required":["code"],"properties":{"code":{"type":"string","description":"Meta error code, encoded as a string.","example":"100","isRequired":true,"uniqueKey":"error.messengerApiError.code","typeLabel":"string"},"subcode":{"type":"string","description":"Meta error subcode, encoded as a string. Omitted if Meta did not provide it.","example":"2018276","uniqueKey":"error.messengerApiError.subcode","typeLabel":"string"}},"uniqueKey":"error.messengerApiError","typeLabel":"object"}},"description":"Contains the error code and human-readable message for the API error.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"status":404,"code":"NOT_FOUND","message":"The requested resource does not exist.","target":"","docUrl":"","requestId":"req_1KjtKI80IKoaJNa6n6p","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>"},"metaBusinessAgentApiError":{"title":"\u003cstring>","detail":"\u003cstring>","type":"\u003cstring>","status":123,"requestId":"\u003cstring>"},"messengerApiError":{"code":"100","subcode":"2018276"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"f28cc001-0f34-46bb-a057-17c6c91bb540":{"description":"404 NOT_FOUND. Missing/unowned Page for a new send, or no record in tenant/from scope.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","code"],"properties":{"status":{"type":"integer","format":"int32","pattern":"[45]\\d{2}","description":"HTTP status code, [RFC 7231, Section 6](https://datatracker.ietf.org/doc/html/rfc7231#section-6). It conveys the HTTP status code used for the convenience of the consumer.","example":404,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer\u003cint32>"},"code":{"type":"string","description":"One of a server-defined error codes. Some `4xx` errors that could be handled programmatically include an error code that briefly explains the error reported.","example":"NOT_FOUND","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable representation of the error. It is intended as an aid to developers and is not suitable for exposure to end users.","example":"The requested resource does not exist.","uniqueKey":"error.message","typeLabel":"string"},"target":{"type":"string","description":"The target of the error.","example":"","uniqueKey":"error.target","typeLabel":"string"},"docUrl":{"type":"string","description":"A URL to more information about the error.","example":"","uniqueKey":"error.docUrl","typeLabel":"string"},"requestId":{"type":"string","description":"Each API request has an associated request ID. It conveys the response header `YCloud-Request-ID` used for the convenience of the consumer.","example":"req_1KjtKI80IKoaJNa6n6p","uniqueKey":"error.requestId","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).\n\nNote: This field is returned if we tried to request the WhatsApp Business API and got an error response.","required":["message","code"],"properties":{"message":{"type":"string","description":"A human-readable description of the error.","example":"HSM Template creation failed","isRequired":true,"uniqueKey":"error.whatsappApiError.message","typeLabel":"string"},"code":{"type":"string","description":"An error code.","example":200002,"isRequired":true,"uniqueKey":"error.whatsappApiError.code","typeLabel":"string"},"type":{"type":"string","description":"Error type.","example":"OAuthException","uniqueKey":"error.whatsappApiError.type","typeLabel":"string"},"is_transient":{"type":"boolean","description":"Whether the error is transient.","example":false,"uniqueKey":"error.whatsappApiError.is_transient","typeLabel":"boolean"},"error_subcode":{"type":"string","description":"Additional code about the error.","example":2388109,"uniqueKey":"error.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":"error.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":"error.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":"error.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":"error.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":"error.whatsappApiError.error_data.oneOf.1","typeLabel":"object"}],"uniqueKey":"error.whatsappApiError.error_data","typeLabel":"string | object"}},"uniqueKey":"error.whatsappApiError","typeLabel":"object"},"metaBusinessAgentApiError":{"type":"object","description":"Sanitized upstream details returned when a Meta Business Agent request fails.","properties":{"title":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.title","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.detail","typeLabel":"string"},"type":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.type","typeLabel":"string"},"status":{"type":"integer","format":"int32","uniqueKey":"error.metaBusinessAgentApiError.status","typeLabel":"integer\u003cint32>"},"requestId":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.requestId","typeLabel":"string"}},"uniqueKey":"error.metaBusinessAgentApiError","typeLabel":"object"},"messengerApiError":{"type":"object","description":"Numeric Meta diagnostics for a confirmed Messenger submission refusal. Omitted when unavailable.","required":["code"],"properties":{"code":{"type":"string","description":"Meta error code, encoded as a string.","example":"100","isRequired":true,"uniqueKey":"error.messengerApiError.code","typeLabel":"string"},"subcode":{"type":"string","description":"Meta error subcode, encoded as a string. Omitted if Meta did not provide it.","example":"2018276","uniqueKey":"error.messengerApiError.subcode","typeLabel":"string"}},"uniqueKey":"error.messengerApiError","typeLabel":"object"}},"description":"Contains the error code and human-readable message for the API error.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"status":404,"code":"NOT_FOUND","message":"The requested resource does not exist.","target":"","docUrl":"","requestId":"req_1KjtKI80IKoaJNa6n6p","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>"},"metaBusinessAgentApiError":{"title":"\u003cstring>","detail":"\u003cstring>","type":"\u003cstring>","status":123,"requestId":"\u003cstring>"},"messengerApiError":{"code":"100","subcode":"2018276"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"c1d83a4a-bff7-4393-ae98-88ac8363b796":{"description":"429 TOO_MANY_REQUESTS. Reuse existing REST rate limiting and applicable retry/rate-limit headers.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","code"],"properties":{"status":{"type":"integer","format":"int32","pattern":"[45]\\d{2}","description":"HTTP status code, [RFC 7231, Section 6](https://datatracker.ietf.org/doc/html/rfc7231#section-6). It conveys the HTTP status code used for the convenience of the consumer.","example":404,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer\u003cint32>"},"code":{"type":"string","description":"One of a server-defined error codes. Some `4xx` errors that could be handled programmatically include an error code that briefly explains the error reported.","example":"NOT_FOUND","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable representation of the error. It is intended as an aid to developers and is not suitable for exposure to end users.","example":"The requested resource does not exist.","uniqueKey":"error.message","typeLabel":"string"},"target":{"type":"string","description":"The target of the error.","example":"","uniqueKey":"error.target","typeLabel":"string"},"docUrl":{"type":"string","description":"A URL to more information about the error.","example":"","uniqueKey":"error.docUrl","typeLabel":"string"},"requestId":{"type":"string","description":"Each API request has an associated request ID. It conveys the response header `YCloud-Request-ID` used for the convenience of the consumer.","example":"req_1KjtKI80IKoaJNa6n6p","uniqueKey":"error.requestId","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).\n\nNote: This field is returned if we tried to request the WhatsApp Business API and got an error response.","required":["message","code"],"properties":{"message":{"type":"string","description":"A human-readable description of the error.","example":"HSM Template creation failed","isRequired":true,"uniqueKey":"error.whatsappApiError.message","typeLabel":"string"},"code":{"type":"string","description":"An error code.","example":200002,"isRequired":true,"uniqueKey":"error.whatsappApiError.code","typeLabel":"string"},"type":{"type":"string","description":"Error type.","example":"OAuthException","uniqueKey":"error.whatsappApiError.type","typeLabel":"string"},"is_transient":{"type":"boolean","description":"Whether the error is transient.","example":false,"uniqueKey":"error.whatsappApiError.is_transient","typeLabel":"boolean"},"error_subcode":{"type":"string","description":"Additional code about the error.","example":2388109,"uniqueKey":"error.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":"error.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":"error.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":"error.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":"error.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":"error.whatsappApiError.error_data.oneOf.1","typeLabel":"object"}],"uniqueKey":"error.whatsappApiError.error_data","typeLabel":"string | object"}},"uniqueKey":"error.whatsappApiError","typeLabel":"object"},"metaBusinessAgentApiError":{"type":"object","description":"Sanitized upstream details returned when a Meta Business Agent request fails.","properties":{"title":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.title","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.detail","typeLabel":"string"},"type":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.type","typeLabel":"string"},"status":{"type":"integer","format":"int32","uniqueKey":"error.metaBusinessAgentApiError.status","typeLabel":"integer\u003cint32>"},"requestId":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.requestId","typeLabel":"string"}},"uniqueKey":"error.metaBusinessAgentApiError","typeLabel":"object"},"messengerApiError":{"type":"object","description":"Numeric Meta diagnostics for a confirmed Messenger submission refusal. Omitted when unavailable.","required":["code"],"properties":{"code":{"type":"string","description":"Meta error code, encoded as a string.","example":"100","isRequired":true,"uniqueKey":"error.messengerApiError.code","typeLabel":"string"},"subcode":{"type":"string","description":"Meta error subcode, encoded as a string. Omitted if Meta did not provide it.","example":"2018276","uniqueKey":"error.messengerApiError.subcode","typeLabel":"string"}},"uniqueKey":"error.messengerApiError","typeLabel":"object"}},"description":"Contains the error code and human-readable message for the API error.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"status":404,"code":"NOT_FOUND","message":"The requested resource does not exist.","target":"","docUrl":"","requestId":"req_1KjtKI80IKoaJNa6n6p","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>"},"metaBusinessAgentApiError":{"title":"\u003cstring>","detail":"\u003cstring>","type":"\u003cstring>","status":123,"requestId":"\u003cstring>"},"messengerApiError":{"code":"100","subcode":"2018276"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"41f32582-76e3-4364-8be9-b01b4bccec57":{"description":"500 INTERNAL_SERVER_ERROR. The service cannot store or retrieve the record, or is not configured correctly. If the send may have reached Meta, the response is 502 MESSENGER_MESSAGE_RESULT_UNKNOWN instead.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","code"],"properties":{"status":{"type":"integer","format":"int32","pattern":"[45]\\d{2}","description":"HTTP status code, [RFC 7231, Section 6](https://datatracker.ietf.org/doc/html/rfc7231#section-6). It conveys the HTTP status code used for the convenience of the consumer.","example":404,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer\u003cint32>"},"code":{"type":"string","description":"One of a server-defined error codes. Some `4xx` errors that could be handled programmatically include an error code that briefly explains the error reported.","example":"NOT_FOUND","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable representation of the error. It is intended as an aid to developers and is not suitable for exposure to end users.","example":"The requested resource does not exist.","uniqueKey":"error.message","typeLabel":"string"},"target":{"type":"string","description":"The target of the error.","example":"","uniqueKey":"error.target","typeLabel":"string"},"docUrl":{"type":"string","description":"A URL to more information about the error.","example":"","uniqueKey":"error.docUrl","typeLabel":"string"},"requestId":{"type":"string","description":"Each API request has an associated request ID. It conveys the response header `YCloud-Request-ID` used for the convenience of the consumer.","example":"req_1KjtKI80IKoaJNa6n6p","uniqueKey":"error.requestId","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).\n\nNote: This field is returned if we tried to request the WhatsApp Business API and got an error response.","required":["message","code"],"properties":{"message":{"type":"string","description":"A human-readable description of the error.","example":"HSM Template creation failed","isRequired":true,"uniqueKey":"error.whatsappApiError.message","typeLabel":"string"},"code":{"type":"string","description":"An error code.","example":200002,"isRequired":true,"uniqueKey":"error.whatsappApiError.code","typeLabel":"string"},"type":{"type":"string","description":"Error type.","example":"OAuthException","uniqueKey":"error.whatsappApiError.type","typeLabel":"string"},"is_transient":{"type":"boolean","description":"Whether the error is transient.","example":false,"uniqueKey":"error.whatsappApiError.is_transient","typeLabel":"boolean"},"error_subcode":{"type":"string","description":"Additional code about the error.","example":2388109,"uniqueKey":"error.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":"error.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":"error.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":"error.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":"error.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":"error.whatsappApiError.error_data.oneOf.1","typeLabel":"object"}],"uniqueKey":"error.whatsappApiError.error_data","typeLabel":"string | object"}},"uniqueKey":"error.whatsappApiError","typeLabel":"object"},"metaBusinessAgentApiError":{"type":"object","description":"Sanitized upstream details returned when a Meta Business Agent request fails.","properties":{"title":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.title","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.detail","typeLabel":"string"},"type":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.type","typeLabel":"string"},"status":{"type":"integer","format":"int32","uniqueKey":"error.metaBusinessAgentApiError.status","typeLabel":"integer\u003cint32>"},"requestId":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.requestId","typeLabel":"string"}},"uniqueKey":"error.metaBusinessAgentApiError","typeLabel":"object"},"messengerApiError":{"type":"object","description":"Numeric Meta diagnostics for a confirmed Messenger submission refusal. Omitted when unavailable.","required":["code"],"properties":{"code":{"type":"string","description":"Meta error code, encoded as a string.","example":"100","isRequired":true,"uniqueKey":"error.messengerApiError.code","typeLabel":"string"},"subcode":{"type":"string","description":"Meta error subcode, encoded as a string. Omitted if Meta did not provide it.","example":"2018276","uniqueKey":"error.messengerApiError.subcode","typeLabel":"string"}},"uniqueKey":"error.messengerApiError","typeLabel":"object"}},"description":"Contains the error code and human-readable message for the API error.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"status":404,"code":"NOT_FOUND","message":"The requested resource does not exist.","target":"","docUrl":"","requestId":"req_1KjtKI80IKoaJNa6n6p","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>"},"metaBusinessAgentApiError":{"title":"\u003cstring>","detail":"\u003cstring>","type":"\u003cstring>","status":123,"requestId":"\u003cstring>"},"messengerApiError":{"code":"100","subcode":"2018276"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"fdb47869-3007-42fc-8d7d-07d842eeedf7":{"description":"502 MESSENGER_MESSAGE_RESULT_UNKNOWN. YCloud cannot confirm the submission result.\nMeta may still have accepted the message. Do not automatically resubmit it.\nCheck the saved status using a returned message ID when available, or contact\nsupport. An unavailable result does not include an invented message ID.\n","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","code"],"properties":{"status":{"type":"integer","format":"int32","pattern":"[45]\\d{2}","description":"HTTP status code, [RFC 7231, Section 6](https://datatracker.ietf.org/doc/html/rfc7231#section-6). It conveys the HTTP status code used for the convenience of the consumer.","example":404,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer\u003cint32>"},"code":{"type":"string","description":"One of a server-defined error codes. Some `4xx` errors that could be handled programmatically include an error code that briefly explains the error reported.","example":"NOT_FOUND","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable representation of the error. It is intended as an aid to developers and is not suitable for exposure to end users.","example":"The requested resource does not exist.","uniqueKey":"error.message","typeLabel":"string"},"target":{"type":"string","description":"The target of the error.","example":"","uniqueKey":"error.target","typeLabel":"string"},"docUrl":{"type":"string","description":"A URL to more information about the error.","example":"","uniqueKey":"error.docUrl","typeLabel":"string"},"requestId":{"type":"string","description":"Each API request has an associated request ID. It conveys the response header `YCloud-Request-ID` used for the convenience of the consumer.","example":"req_1KjtKI80IKoaJNa6n6p","uniqueKey":"error.requestId","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).\n\nNote: This field is returned if we tried to request the WhatsApp Business API and got an error response.","required":["message","code"],"properties":{"message":{"type":"string","description":"A human-readable description of the error.","example":"HSM Template creation failed","isRequired":true,"uniqueKey":"error.whatsappApiError.message","typeLabel":"string"},"code":{"type":"string","description":"An error code.","example":200002,"isRequired":true,"uniqueKey":"error.whatsappApiError.code","typeLabel":"string"},"type":{"type":"string","description":"Error type.","example":"OAuthException","uniqueKey":"error.whatsappApiError.type","typeLabel":"string"},"is_transient":{"type":"boolean","description":"Whether the error is transient.","example":false,"uniqueKey":"error.whatsappApiError.is_transient","typeLabel":"boolean"},"error_subcode":{"type":"string","description":"Additional code about the error.","example":2388109,"uniqueKey":"error.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":"error.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":"error.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":"error.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":"error.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":"error.whatsappApiError.error_data.oneOf.1","typeLabel":"object"}],"uniqueKey":"error.whatsappApiError.error_data","typeLabel":"string | object"}},"uniqueKey":"error.whatsappApiError","typeLabel":"object"},"metaBusinessAgentApiError":{"type":"object","description":"Sanitized upstream details returned when a Meta Business Agent request fails.","properties":{"title":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.title","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.detail","typeLabel":"string"},"type":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.type","typeLabel":"string"},"status":{"type":"integer","format":"int32","uniqueKey":"error.metaBusinessAgentApiError.status","typeLabel":"integer\u003cint32>"},"requestId":{"type":"string","uniqueKey":"error.metaBusinessAgentApiError.requestId","typeLabel":"string"}},"uniqueKey":"error.metaBusinessAgentApiError","typeLabel":"object"},"messengerApiError":{"type":"object","description":"Numeric Meta diagnostics for a confirmed Messenger submission refusal. Omitted when unavailable.","required":["code"],"properties":{"code":{"type":"string","description":"Meta error code, encoded as a string.","example":"100","isRequired":true,"uniqueKey":"error.messengerApiError.code","typeLabel":"string"},"subcode":{"type":"string","description":"Meta error subcode, encoded as a string. Omitted if Meta did not provide it.","example":"2018276","uniqueKey":"error.messengerApiError.subcode","typeLabel":"string"}},"uniqueKey":"error.messengerApiError","typeLabel":"object"}},"description":"Contains the error code and human-readable message for the API error.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"status":404,"code":"NOT_FOUND","message":"The requested resource does not exist.","target":"","docUrl":"","requestId":"req_1KjtKI80IKoaJNa6n6p","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>"},"metaBusinessAgentApiError":{"title":"\u003cstring>","detail":"\u003cstring>","type":"\u003cstring>","status":123,"requestId":"\u003cstring>"},"messengerApiError":{"code":"100","subcode":"2018276"}}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"7503a75c-64b3-4782-8bfc-d29e73d70610":{"api_key":{"type":"apiKey","name":"X-API-Key","in":"header","scopes":[],"schemeName":"api_key"}}},"servers":{"0c746aad-c516-48bc-b122-f236a679949c":{"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":"Send a Messenger text reply directly - YCloud Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/messenger-messages/send-a-messenger-text-reply-directly","matchLevel":0},"zh":{"href":"/api-reference/messenger-messages/send-a-messenger-text-reply-directly","matchLevel":0},"es":{"href":"/api-reference/messenger-messages/send-a-messenger-text-reply-directly","matchLevel":0},"pt":{"href":"/api-reference/messenger-messages/send-a-messenger-text-reply-directly","matchLevel":0},"ru":{"href":"/api-reference/messenger-messages/send-a-messenger-text-reply-directly","matchLevel":0}}},"lastModified":"2026-11-16T09:51:30.348Z","originalFileLocation":"api-reference/messenger-messages/send-a-messenger-text-reply-directly.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=\"Use your connected Facebook Page to send a one-to-one text reply. Meta determines reply eligibility; YCloud does not precheck the messaging window. Use a Tenant API Key. Developer App API Keys are not supported. Each call submits a new message. If a timeout occurs or you receive 502 MESSENGER_MESSAGE_RESULT_UNKNOWN, Meta may still have accepted the message. Do not automatically resubmit it. Check the saved message status using a returned YCloud or Meta message ID when available, or contact support to investigate.\">\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=\"Send a Messenger text reply directly - YCloud Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Use your connected Facebook Page to send a one-to-one text reply. Meta determines reply eligibility; YCloud does not precheck the messaging window. Use a Tenant API Key. Developer App API Keys are not supported. Each call submits a new message. If a timeout occurs or you receive 502 MESSENGER_MESSAGE_RESULT_UNKNOWN, Meta may still have accepted the message. Do not automatically resubmit it. Check the saved message status using a returned YCloud or Meta message ID when available, or contact support to investigate.\">\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/messenger-messages/send-a-messenger-text-reply-directly\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://lchnan.mintlify.site/_mintlify/api/og/v2?division=Messenger+Messages\u0026amp;title=Send+a+Messenger+text+reply+directly\u0026amp;description=Use+your+connected+Facebook+Page+to+send+a+one-to-one+text+reply.%0AMeta+determines+reply+eligibility%3B+YCloud+does+not+precheck+the+messaging+window.%0AUse+a+Tenant\u0026amp;theme=73a4e124bf0b360368afc7b1\u0026amp;signature=6a8d49df55cf97cf69217d79900fa395eb45886adc420e65afa74270d12edaf7\">\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=\"Send a Messenger text reply directly - YCloud Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Use your connected Facebook Page to send a one-to-one text reply. Meta determines reply eligibility; YCloud does not precheck the messaging window. Use a Tenant API Key. Developer App API Keys are not supported. Each call submits a new message. If a timeout occurs or you receive 502 MESSENGER_MESSAGE_RESULT_UNKNOWN, Meta may still have accepted the message. Do not automatically resubmit it. Check the saved message status using a returned YCloud or Meta message ID when available, or contact support to investigate.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lchnan.mintlify.site/_mintlify/api/og/v2?division=Messenger+Messages\u0026amp;title=Send+a+Messenger+text+reply+directly\u0026amp;description=Use+your+connected+Facebook+Page+to+send+a+one-to-one+text+reply.%0AMeta+determines+reply+eligibility%3B+YCloud+does+not+precheck+the+messaging+window.%0AUse+a+Tenant\u0026amp;theme=73a4e124bf0b360368afc7b1\u0026amp;signature=6a8d49df55cf97cf69217d79900fa395eb45886adc420e65afa74270d12edaf7\">\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/messenger-messages/send-a-messenger-text-reply-directly\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/messenger-messages/send-a-messenger-text-reply-directly.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/messenger-messages/send-a-messenger-text-reply-directly#webpage\",\"url\":\"https://docs.ycloud.com/api-reference/messenger-messages/send-a-messenger-text-reply-directly\",\"name\":\"Send a Messenger text reply directly\",\"description\":\"Use your connected Facebook Page to send a one-to-one text reply. Meta determines reply eligibility; YCloud does not precheck the messaging window. Use a Tenant API Key. Developer App API Keys are not supported. Each call submits a new message. If a timeout occurs or you receive 502 MESSENGER_MESSAGE_RESULT_UNKNOWN, Meta may still have accepted the message. Do not automatically resubmit it. Check the saved message status using a returned YCloud or Meta message ID when available, or contact support to investigate.\",\"dateModified\":\"2026-11-16T09:51:30.348Z\",\"isPartOf\":{\"@id\":\"https://docs.ycloud.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ycloud.com/api-reference/messenger-messages/send-a-messenger-text-reply-directly#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ycloud.com/api-reference/messenger-messages/send-a-messenger-text-reply-directly#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\":\"Send a Messenger text reply directly\",\"item\":\"https://docs.ycloud.com/api-reference/messenger-messages/send-a-messenger-text-reply-directly\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.ycloud.com/api-reference/messenger-messages/send-a-messenger-text-reply-directly#apireference\",\"headline\":\"Send a Messenger text reply directly\",\"name\":\"Send a Messenger text reply directly\",\"description\":\"Use your connected Facebook Page to send a one-to-one text reply. Meta determines reply eligibility; YCloud does not precheck the messaging window. Use a Tenant API Key. Developer App API Keys are not supported. Each call submits a new message. If a timeout occurs or you receive 502 MESSENGER_MESSAGE_RESULT_UNKNOWN, Meta may still have accepted the message. Do not automatically resubmit it. Check the saved message status using a returned YCloud or Meta message ID when available, or contact support to investigate.\",\"url\":\"https://docs.ycloud.com/api-reference/messenger-messages/send-a-messenger-text-reply-directly\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ycloud.com/api-reference/messenger-messages/send-a-messenger-text-reply-directly#webpage\"},\"dateModified\":\"2026-11-16T09:51:30.348Z\",\"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\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"YCloud Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/messenger-messages/send-a-messenger-text-reply-directly.md","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"},{"title":"YCloud Developer Kit","href":"/en/api-reference/getting-started/ycloud-developer-kit"}]},{"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":"Example overview","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"}]},{"title":"Webhook examples","href":"/en/api-reference/webhook-reference/overview"}]}]},{"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","description":"Submits one representative message sample to Meta and returns its detected category.\nWe recommend submitting 3–4 samples that cover your utility use cases, one per request.\nThis request does not send a message to a recipient.\n\nUtility Direct Send is in public beta. You do not need to join an allowlist or apply for access.\nUse an API key for the YCloud account that manages the specified WhatsApp Business Account.\n\nSamples support text, an interactive CTA URL button, or interactive reply buttons.\nSee [Utility Direct Send](/en/api-reference/guides/whatsapp-platform/best-practices/direct-send)\nfor limits, sending examples, and template conversion.","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","description":"Retrieves a locally stored outbound record scoped by authenticated tenant and from.\nDoes not query Meta or require the Page to remain connected. There is no inbound\ndetail lookup or public message-history list in this phase.\n","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":"Check a Meta contact book entry","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/contactBook/{bsuid}","href":"/api-reference/whatsapp-phone-numbers/check-a-meta-contact-book-entry"},{"title":"Delete a Meta contact book entry","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/contactBook/{bsuid}","href":"/api-reference/whatsapp-phone-numbers/delete-a-meta-contact-book-entry"}]},{"group":"WhatsApp Templates","pages":[{"title":"Create a template","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/templates","href":"/api-reference/whatsapp-templates/create-a-template"},{"title":"List templates","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/templates","href":"/api-reference/whatsapp-templates/list-templates"},{"title":"Retrieve WhatsApp template analytics","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/templates/analytics","href":"/api-reference/whatsapp-templates/retrieve-whatsapp-template-analytics"},{"title":"Delete templates by name","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/templates/{wabaId}/{name}","href":"/api-reference/whatsapp-templates/delete-templates-by-name"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/templates/{wabaId}/{name}/{language}","href":"/api-reference/whatsapp-templates/delete-a-template"},{"title":"Edit a template","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/templates/{wabaId}/{name}/{language}","href":"/api-reference/whatsapp-templates/edit-a-template"},{"title":"Retrieve a template","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/templates/{wabaId}/{name}/{language}","href":"/api-reference/whatsapp-templates/retrieve-a-template"}]},{"group":"WhatsApp Flows","pages":[{"title":"Create a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/flows","href":"/api-reference/whatsapp-flows/create-a-flow"},{"title":"List flows","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/flows","href":"/api-reference/whatsapp-flows/list-flows"},{"title":"Update flow metadata","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/flows/{flowId}/metadata","href":"/api-reference/whatsapp-flows/update-flow-metadata"},{"title":"Update flow structure","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/flows/{flowId}/assets","href":"/api-reference/whatsapp-flows/update-flow-structure"},{"title":"Delete a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/flows/{flowId}","href":"/api-reference/whatsapp-flows/delete-a-flow"},{"title":"Retrieve a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/flows/{flowId}","href":"/api-reference/whatsapp-flows/retrieve-a-flow"},{"title":"Publish a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/flows/{flowId}/publish","href":"/api-reference/whatsapp-flows/publish-a-flow"},{"title":"Deprecate a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/flows/{flowId}/deprecate","href":"/api-reference/whatsapp-flows/deprecate-a-flow"},{"title":"generate a web preview URL with this flow.","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/flows/{flowId}/preview","href":"/api-reference/whatsapp-flows/generate-a-web-preview-url-with-this-flow"}]},{"group":"CTWA","pages":[{"title":"Submit a conversion event","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /ctwa/conversionEvents","href":"/api-reference/ctwa/submit-a-conversion-event"},{"title":"Submit conversion events","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /ctwa/conversionEvents/batch","href":"/api-reference/ctwa/submit-conversion-events"}]},{"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":"Webhook reference","pages":[{"group":"Messenger","pages":[{"title":"messenger.inbound_message.received","sidebarTitle":"messenger.inbound_message.received","href":"/en/api-reference/webhook-reference/messenger-inbound-message-received"},{"title":"messenger.inbound_message.updated","sidebarTitle":"messenger.inbound_message.updated","href":"/en/api-reference/webhook-reference/messenger-inbound-message-updated"},{"title":"messenger.message.updated","sidebarTitle":"messenger.message.updated","href":"/en/api-reference/webhook-reference/messenger-message-updated"},{"title":"messenger.message_reaction.updated","sidebarTitle":"messenger.message_reaction.updated","href":"/en/api-reference/webhook-reference/messenger-message-reaction-updated"}]},{"group":"WhatsApp messages","pages":[{"title":"whatsapp.inbound_message.received","sidebarTitle":"inbound_message.received","href":"/en/api-reference/webhook-reference/whatsapp-inbound-message-received"},{"title":"whatsapp.message.updated","sidebarTitle":"message.updated","href":"/en/api-reference/webhook-reference/whatsapp-message-updated"},{"title":"whatsapp.user.preferences","sidebarTitle":"user.preferences","href":"/en/api-reference/webhook-reference/whatsapp-user-preferences"}]},{"group":"WhatsApp templates","pages":[{"title":"whatsapp.template.category_updated","sidebarTitle":"category_updated","href":"/en/api-reference/webhook-reference/whatsapp-template-category-updated"},{"title":"whatsapp.template.correct_category_detection","sidebarTitle":"correct_category_detection","href":"/en/api-reference/webhook-reference/whatsapp-template-correct-category-detection"},{"title":"whatsapp.template.quality_updated","sidebarTitle":"quality_updated","href":"/en/api-reference/webhook-reference/whatsapp-template-quality-updated"},{"title":"whatsapp.template.reviewed","sidebarTitle":"reviewed","href":"/en/api-reference/webhook-reference/whatsapp-template-reviewed"}]},{"group":"WhatsApp accounts","pages":[{"title":"whatsapp.business_account.deleted","sidebarTitle":"deleted","href":"/en/api-reference/webhook-reference/whatsapp-business-account-deleted"},{"title":"whatsapp.business_account.reviewed","sidebarTitle":"reviewed","href":"/en/api-reference/webhook-reference/whatsapp-business-account-reviewed"},{"title":"whatsapp.business_account.updated","sidebarTitle":"updated","href":"/en/api-reference/webhook-reference/whatsapp-business-account-updated"}]},{"group":"WhatsApp phone numbers","pages":[{"title":"whatsapp.phone_number.deleted","sidebarTitle":"deleted","href":"/en/api-reference/webhook-reference/whatsapp-phone-number-deleted"},{"title":"whatsapp.phone_number.name_updated","sidebarTitle":"name_updated","href":"/en/api-reference/webhook-reference/whatsapp-phone-number-name-updated"},{"title":"whatsapp.phone_number.quality_updated","sidebarTitle":"quality_updated","href":"/en/api-reference/webhook-reference/whatsapp-phone-number-quality-updated"},{"title":"whatsapp.phone_number.business_username_updated","sidebarTitle":"business_username_updated","href":"/en/api-reference/webhook-reference/whatsapp-phone-number-business-username-updated"}]},{"group":"WhatsApp Business App","pages":[{"title":"whatsapp.smb.history","sidebarTitle":"smb.history","href":"/en/api-reference/webhook-reference/whatsapp-smb-history"},{"title":"whatsapp.smb.message.created","sidebarTitle":"smb.message.created","href":"/en/api-reference/webhook-reference/whatsapp-smb-message-created"},{"title":"whatsapp.smb.message.echoes","sidebarTitle":"smb.message.echoes","href":"/en/api-reference/webhook-reference/whatsapp-smb-message-echoes"}]},{"group":"WhatsApp Agents","pages":[{"title":"whatsapp.echo_message.created","sidebarTitle":"echo_message.created","href":"/en/api-reference/webhook-reference/whatsapp-echo-message-created"},{"title":"whatsapp.echo_message.updated","sidebarTitle":"echo_message.updated","href":"/en/api-reference/webhook-reference/whatsapp-echo-message-updated"},{"title":"whatsapp.meta_business_agent.handover.updated","sidebarTitle":"meta_business_agent.handover.updated","href":"/en/api-reference/webhook-reference/whatsapp-meta-business-agent-handover-updated"}]},{"group":"WhatsApp calls","pages":[{"title":"whatsapp.call.connect","sidebarTitle":"call.connect","href":"/en/api-reference/webhook-reference/whatsapp-call-connect"},{"title":"whatsapp.call.terminate","sidebarTitle":"call.terminate","href":"/en/api-reference/webhook-reference/whatsapp-call-terminate"},{"title":"whatsapp.call.status.updated","sidebarTitle":"call.status.updated","href":"/en/api-reference/webhook-reference/whatsapp-call-status-updated"},{"title":"whatsapp.call.recording.updated","sidebarTitle":"call.recording.updated","href":"/en/api-reference/webhook-reference/whatsapp-call-recording-updated"},{"title":"whatsapp.call.transcription.updated","sidebarTitle":"call.transcription.updated","href":"/en/api-reference/webhook-reference/whatsapp-call-transcription-updated"}]},{"group":"WhatsApp groups","pages":[{"title":"whatsapp.group.lifecycle_update","sidebarTitle":"lifecycle_update","href":"/en/api-reference/webhook-reference/whatsapp-group-lifecycle-update"},{"title":"whatsapp.group.participants_update","sidebarTitle":"participants_update","href":"/en/api-reference/webhook-reference/whatsapp-group-participants-update"},{"title":"whatsapp.group.settings_update","sidebarTitle":"settings_update","href":"/en/api-reference/webhook-reference/whatsapp-group-settings-update"},{"title":"whatsapp.group.status_update","sidebarTitle":"status_update","href":"/en/api-reference/webhook-reference/whatsapp-group-status-update"}]},{"group":"WhatsApp Flows and payments","pages":[{"title":"whatsapp.flow.status_change","sidebarTitle":"flow.status_change","href":"/en/api-reference/webhook-reference/whatsapp-flow-status-change"},{"title":"whatsapp.payment.updated","sidebarTitle":"payment.updated","href":"/en/api-reference/webhook-reference/whatsapp-payment-updated"}]},{"group":"Contacts","pages":[{"title":"contact.attributes_changed","sidebarTitle":"attributes_changed","href":"/en/api-reference/webhook-reference/contact-attributes-changed"},{"title":"contact.created","sidebarTitle":"created","href":"/en/api-reference/webhook-reference/contact-created"},{"title":"contact.deleted","sidebarTitle":"deleted","href":"/en/api-reference/webhook-reference/contact-deleted"},{"title":"contact.unsubscribe.created","sidebarTitle":"unsubscribe.created","href":"/en/api-reference/webhook-reference/contact-unsubscribe-created"},{"title":"contact.unsubscribe.deleted","sidebarTitle":"unsubscribe.deleted","href":"/en/api-reference/webhook-reference/contact-unsubscribe-deleted"},{"title":"contact.note.created","sidebarTitle":"note.created","href":"/en/api-reference/webhook-reference/contact-note-created"},{"title":"contact.note.updated","sidebarTitle":"note.updated","href":"/en/api-reference/webhook-reference/contact-note-updated"},{"title":"contact.note.deleted","sidebarTitle":"note.deleted","href":"/en/api-reference/webhook-reference/contact-note-deleted"}]},{"group":"Email, SMS, and Voice","pages":[{"title":"email.delivery.updated","sidebarTitle":"email.delivery.updated","href":"/en/api-reference/webhook-reference/email-delivery-updated"},{"title":"sms.message.updated","sidebarTitle":"sms.message.updated","href":"/en/api-reference/webhook-reference/sms-message-updated"},{"title":"sms.inbound.received","sidebarTitle":"sms.inbound.received","href":"/en/api-reference/webhook-reference/sms-inbound-received"},{"title":"voice.message.updated","sidebarTitle":"voice.message.updated","href":"/en/api-reference/webhook-reference/voice-message-updated"}]}]}]},{"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"},{"title":"YCloud Developer Kit","href":"/zh/api-reference/getting-started/ycloud-developer-kit"}]},{"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":"示例概述","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"}]},{"title":"Webhook 示例","href":"/zh/api-reference/webhook-reference/overview"}]}]},{"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","description":"Submits one representative message sample to Meta and returns its detected category.\nWe recommend submitting 3–4 samples that cover your utility use cases, one per request.\nThis request does not send a message to a recipient.\n\nUtility Direct Send is in public beta. You do not need to join an allowlist or apply for access.\nUse an API key for the YCloud account that manages the specified WhatsApp Business Account.\n\nSamples support text, an interactive CTA URL button, or interactive reply buttons.\nSee [Utility Direct Send](/en/api-reference/guides/whatsapp-platform/best-practices/direct-send)\nfor limits, sending examples, and template conversion.","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","description":"Retrieves a locally stored outbound record scoped by authenticated tenant and from.\nDoes not query Meta or require the Page to remain connected. There is no inbound\ndetail lookup or public message-history list in this phase.\n","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":"Check a Meta contact book entry","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/contactBook/{bsuid}","href":"/api-reference/whatsapp-phone-numbers/check-a-meta-contact-book-entry"},{"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","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/templates","href":"/api-reference/whatsapp-templates/create-a-template"},{"title":"List templates","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/templates","href":"/api-reference/whatsapp-templates/list-templates"},{"title":"Retrieve WhatsApp template analytics","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/templates/analytics","href":"/api-reference/whatsapp-templates/retrieve-whatsapp-template-analytics"},{"title":"Delete templates by name","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/templates/{wabaId}/{name}","href":"/api-reference/whatsapp-templates/delete-templates-by-name"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/templates/{wabaId}/{name}/{language}","href":"/api-reference/whatsapp-templates/delete-a-template"},{"title":"Edit a template","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/templates/{wabaId}/{name}/{language}","href":"/api-reference/whatsapp-templates/edit-a-template"},{"title":"Retrieve a template","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/templates/{wabaId}/{name}/{language}","href":"/api-reference/whatsapp-templates/retrieve-a-template"}]},{"group":"WhatsApp Flows","pages":[{"title":"Create a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/flows","href":"/api-reference/whatsapp-flows/create-a-flow"},{"title":"List flows","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/flows","href":"/api-reference/whatsapp-flows/list-flows"},{"title":"Update flow metadata","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/flows/{flowId}/metadata","href":"/api-reference/whatsapp-flows/update-flow-metadata"},{"title":"Update flow structure","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/flows/{flowId}/assets","href":"/api-reference/whatsapp-flows/update-flow-structure"},{"title":"Delete a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/flows/{flowId}","href":"/api-reference/whatsapp-flows/delete-a-flow"},{"title":"Retrieve a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/flows/{flowId}","href":"/api-reference/whatsapp-flows/retrieve-a-flow"},{"title":"Publish a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/flows/{flowId}/publish","href":"/api-reference/whatsapp-flows/publish-a-flow"},{"title":"Deprecate a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/flows/{flowId}/deprecate","href":"/api-reference/whatsapp-flows/deprecate-a-flow"},{"title":"generate a web preview URL with this flow.","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/flows/{flowId}/preview","href":"/api-reference/whatsapp-flows/generate-a-web-preview-url-with-this-flow"}]},{"group":"CTWA","pages":[{"title":"Submit a conversion event","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /ctwa/conversionEvents","href":"/api-reference/ctwa/submit-a-conversion-event"},{"title":"Submit conversion events","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /ctwa/conversionEvents/batch","href":"/api-reference/ctwa/submit-conversion-events"}]},{"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":"Webhook reference","pages":[{"group":"Messenger","pages":[{"title":"messenger.inbound_message.received","sidebarTitle":"messenger.inbound_message.received","href":"/zh/api-reference/webhook-reference/messenger-inbound-message-received"},{"title":"messenger.inbound_message.updated","sidebarTitle":"messenger.inbound_message.updated","href":"/zh/api-reference/webhook-reference/messenger-inbound-message-updated"},{"title":"messenger.message.updated","sidebarTitle":"messenger.message.updated","href":"/zh/api-reference/webhook-reference/messenger-message-updated"},{"title":"messenger.message_reaction.updated","sidebarTitle":"messenger.message_reaction.updated","href":"/zh/api-reference/webhook-reference/messenger-message-reaction-updated"}]},{"group":"WhatsApp messages","pages":[{"title":"whatsapp.inbound_message.received","sidebarTitle":"inbound_message.received","href":"/zh/api-reference/webhook-reference/whatsapp-inbound-message-received"},{"title":"whatsapp.message.updated","sidebarTitle":"message.updated","href":"/zh/api-reference/webhook-reference/whatsapp-message-updated"},{"title":"whatsapp.user.preferences","sidebarTitle":"user.preferences","href":"/zh/api-reference/webhook-reference/whatsapp-user-preferences"}]},{"group":"WhatsApp templates","pages":[{"title":"whatsapp.template.category_updated","sidebarTitle":"category_updated","href":"/zh/api-reference/webhook-reference/whatsapp-template-category-updated"},{"title":"whatsapp.template.correct_category_detection","sidebarTitle":"correct_category_detection","href":"/zh/api-reference/webhook-reference/whatsapp-template-correct-category-detection"},{"title":"whatsapp.template.quality_updated","sidebarTitle":"quality_updated","href":"/zh/api-reference/webhook-reference/whatsapp-template-quality-updated"},{"title":"whatsapp.template.reviewed","sidebarTitle":"reviewed","href":"/zh/api-reference/webhook-reference/whatsapp-template-reviewed"}]},{"group":"WhatsApp accounts","pages":[{"title":"whatsapp.business_account.deleted","sidebarTitle":"deleted","href":"/zh/api-reference/webhook-reference/whatsapp-business-account-deleted"},{"title":"whatsapp.business_account.reviewed","sidebarTitle":"reviewed","href":"/zh/api-reference/webhook-reference/whatsapp-business-account-reviewed"},{"title":"whatsapp.business_account.updated","sidebarTitle":"已更新","href":"/zh/api-reference/webhook-reference/whatsapp-business-account-updated"}]},{"group":"WhatsApp phone numbers","pages":[{"title":"whatsapp.phone_number.deleted","sidebarTitle":"deleted","href":"/zh/api-reference/webhook-reference/whatsapp-phone-number-deleted"},{"title":"whatsapp.phone_number.name_updated","sidebarTitle":"name_updated","href":"/zh/api-reference/webhook-reference/whatsapp-phone-number-name-updated"},{"title":"whatsapp.phone_number.quality_updated","sidebarTitle":"quality_updated","href":"/zh/api-reference/webhook-reference/whatsapp-phone-number-quality-updated"},{"title":"whatsapp.phone_number.business_username_updated","sidebarTitle":"business_username_updated","href":"/zh/api-reference/webhook-reference/whatsapp-phone-number-business-username-updated"}]},{"group":"WhatsApp Business App","pages":[{"title":"whatsapp.smb.history","sidebarTitle":"smb.history","href":"/zh/api-reference/webhook-reference/whatsapp-smb-history"},{"title":"whatsapp.smb.message.created","sidebarTitle":"smb.message.created","href":"/zh/api-reference/webhook-reference/whatsapp-smb-message-created"},{"title":"whatsapp.smb.message.echoes","sidebarTitle":"smb.message.echoes","href":"/zh/api-reference/webhook-reference/whatsapp-smb-message-echoes"}]},{"group":"WhatsApp Agents","pages":[{"title":"whatsapp.echo_message.created","sidebarTitle":"echo_message.created","href":"/zh/api-reference/webhook-reference/whatsapp-echo-message-created"},{"title":"whatsapp.echo_message.updated","sidebarTitle":"echo_message.updated","href":"/zh/api-reference/webhook-reference/whatsapp-echo-message-updated"},{"title":"whatsapp.meta_business_agent.handover.updated","sidebarTitle":"meta_business_agent.handover.updated","href":"/zh/api-reference/webhook-reference/whatsapp-meta-business-agent-handover-updated"}]},{"group":"WhatsApp calls","pages":[{"title":"whatsapp.call.connect","sidebarTitle":"call.connect","href":"/zh/api-reference/webhook-reference/whatsapp-call-connect"},{"title":"whatsapp.call.terminate","sidebarTitle":"call.terminate","href":"/zh/api-reference/webhook-reference/whatsapp-call-terminate"},{"title":"whatsapp.call.status.updated","sidebarTitle":"call.status.updated","href":"/zh/api-reference/webhook-reference/whatsapp-call-status-updated"},{"title":"whatsapp.call.recording.updated","sidebarTitle":"call.recording.updated","href":"/zh/api-reference/webhook-reference/whatsapp-call-recording-updated"},{"title":"whatsapp.call.transcription.updated","sidebarTitle":"call.transcription.updated","href":"/zh/api-reference/webhook-reference/whatsapp-call-transcription-updated"}]},{"group":"WhatsApp groups","pages":[{"title":"whatsapp.group.lifecycle_update","sidebarTitle":"lifecycle_update","href":"/zh/api-reference/webhook-reference/whatsapp-group-lifecycle-update"},{"title":"whatsapp.group.participants_update","sidebarTitle":"participants_update","href":"/zh/api-reference/webhook-reference/whatsapp-group-participants-update"},{"title":"whatsapp.group.settings_update","sidebarTitle":"settings_update","href":"/zh/api-reference/webhook-reference/whatsapp-group-settings-update"},{"title":"whatsapp.group.status_update","sidebarTitle":"status_update","href":"/zh/api-reference/webhook-reference/whatsapp-group-status-update"}]},{"group":"WhatsApp Flows and payments","pages":[{"title":"whatsapp.flow.status_change","sidebarTitle":"flow.status_change","href":"/zh/api-reference/webhook-reference/whatsapp-flow-status-change"},{"title":"whatsapp.payment.updated","sidebarTitle":"payment.updated","href":"/zh/api-reference/webhook-reference/whatsapp-payment-updated"}]},{"group":"Contacts","pages":[{"title":"contact.attributes_changed","sidebarTitle":"attributes_changed","href":"/zh/api-reference/webhook-reference/contact-attributes-changed"},{"title":"contact.created","sidebarTitle":"created","href":"/zh/api-reference/webhook-reference/contact-created"},{"title":"contact.deleted","sidebarTitle":"deleted","href":"/zh/api-reference/webhook-reference/contact-deleted"},{"title":"contact.unsubscribe.created","sidebarTitle":"unsubscribe.created","href":"/zh/api-reference/webhook-reference/contact-unsubscribe-created"},{"title":"contact.unsubscribe.deleted","sidebarTitle":"unsubscribe.deleted","href":"/zh/api-reference/webhook-reference/contact-unsubscribe-deleted"},{"title":"contact.note.created","sidebarTitle":"note.created","href":"/zh/api-reference/webhook-reference/contact-note-created"},{"title":"contact.note.updated","sidebarTitle":"note.updated","href":"/zh/api-reference/webhook-reference/contact-note-updated"},{"title":"contact.note.deleted","sidebarTitle":"note.deleted","href":"/zh/api-reference/webhook-reference/contact-note-deleted"}]},{"group":"Email, SMS, and Voice","pages":[{"title":"email.delivery.updated","sidebarTitle":"email.delivery.updated","href":"/zh/api-reference/webhook-reference/email-delivery-updated"},{"title":"sms.message.updated","sidebarTitle":"sms.message.updated","href":"/zh/api-reference/webhook-reference/sms-message-updated"},{"title":"sms.inbound.received","sidebarTitle":"sms.inbound.received","href":"/zh/api-reference/webhook-reference/sms-inbound-received"},{"title":"voice.message.updated","sidebarTitle":"voice.message.updated","href":"/zh/api-reference/webhook-reference/voice-message-updated"}]}]}]},{"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"},{"title":"YCloud Developer Kit","href":"/es/api-reference/getting-started/ycloud-developer-kit"}]},{"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":"Gestionar 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":"Usa identificadores de usuario con ámbito empresarial (BSUID)","href":"/es/api-reference/guides/whatsapp-platform/use-business-scoped-user-ids"}]},{"group":"Plantillas y flujos","pages":[{"title":"Gestionar 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":"Implementa de forma 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":"Resumen de ejemplos","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"}]},{"title":"Ejemplos de Webhook","href":"/es/api-reference/webhook-reference/overview"}]}]},{"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","description":"Submits one representative message sample to Meta and returns its detected category.\nWe recommend submitting 3–4 samples that cover your utility use cases, one per request.\nThis request does not send a message to a recipient.\n\nUtility Direct Send is in public beta. You do not need to join an allowlist or apply for access.\nUse an API key for the YCloud account that manages the specified WhatsApp Business Account.\n\nSamples support text, an interactive CTA URL button, or interactive reply buttons.\nSee [Utility Direct Send](/en/api-reference/guides/whatsapp-platform/best-practices/direct-send)\nfor limits, sending examples, and template conversion.","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","description":"Retrieves a locally stored outbound record scoped by authenticated tenant and from.\nDoes not query Meta or require the Page to remain connected. There is no inbound\ndetail lookup or public message-history list in this phase.\n","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":"Check a Meta contact book entry","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/contactBook/{bsuid}","href":"/api-reference/whatsapp-phone-numbers/check-a-meta-contact-book-entry"},{"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","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/templates","href":"/api-reference/whatsapp-templates/create-a-template"},{"title":"List templates","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/templates","href":"/api-reference/whatsapp-templates/list-templates"},{"title":"Retrieve WhatsApp template analytics","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/templates/analytics","href":"/api-reference/whatsapp-templates/retrieve-whatsapp-template-analytics"},{"title":"Delete templates by name","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/templates/{wabaId}/{name}","href":"/api-reference/whatsapp-templates/delete-templates-by-name"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/templates/{wabaId}/{name}/{language}","href":"/api-reference/whatsapp-templates/delete-a-template"},{"title":"Edit a template","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/templates/{wabaId}/{name}/{language}","href":"/api-reference/whatsapp-templates/edit-a-template"},{"title":"Retrieve a template","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/templates/{wabaId}/{name}/{language}","href":"/api-reference/whatsapp-templates/retrieve-a-template"}]},{"group":"WhatsApp Flows","pages":[{"title":"Create a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/flows","href":"/api-reference/whatsapp-flows/create-a-flow"},{"title":"List flows","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/flows","href":"/api-reference/whatsapp-flows/list-flows"},{"title":"Update flow metadata","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/flows/{flowId}/metadata","href":"/api-reference/whatsapp-flows/update-flow-metadata"},{"title":"Update flow structure","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/flows/{flowId}/assets","href":"/api-reference/whatsapp-flows/update-flow-structure"},{"title":"Delete a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/flows/{flowId}","href":"/api-reference/whatsapp-flows/delete-a-flow"},{"title":"Retrieve a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/flows/{flowId}","href":"/api-reference/whatsapp-flows/retrieve-a-flow"},{"title":"Publish a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/flows/{flowId}/publish","href":"/api-reference/whatsapp-flows/publish-a-flow"},{"title":"Deprecate a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/flows/{flowId}/deprecate","href":"/api-reference/whatsapp-flows/deprecate-a-flow"},{"title":"generate a web preview URL with this flow.","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/flows/{flowId}/preview","href":"/api-reference/whatsapp-flows/generate-a-web-preview-url-with-this-flow"}]},{"group":"CTWA","pages":[{"title":"Submit a conversion event","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /ctwa/conversionEvents","href":"/api-reference/ctwa/submit-a-conversion-event"},{"title":"Submit conversion events","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /ctwa/conversionEvents/batch","href":"/api-reference/ctwa/submit-conversion-events"}]},{"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":"Información general sobre 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":"Webhook reference","pages":[{"group":"Messenger","pages":[{"title":"messenger.inbound_message.received","sidebarTitle":"messenger.inbound_message.received","href":"/es/api-reference/webhook-reference/messenger-inbound-message-received"},{"title":"messenger.inbound_message.updated","sidebarTitle":"messenger.inbound_message.updated","href":"/es/api-reference/webhook-reference/messenger-inbound-message-updated"},{"title":"messenger.message.updated","sidebarTitle":"messenger.message.updated","href":"/es/api-reference/webhook-reference/messenger-message-updated"},{"title":"messenger.message_reaction.updated","sidebarTitle":"messenger.message_reaction.updated","href":"/es/api-reference/webhook-reference/messenger-message-reaction-updated"}]},{"group":"WhatsApp messages","pages":[{"title":"whatsapp.inbound_message.received","sidebarTitle":"inbound_message.received","href":"/es/api-reference/webhook-reference/whatsapp-inbound-message-received"},{"title":"whatsapp.message.updated","sidebarTitle":"message.updated","href":"/es/api-reference/webhook-reference/whatsapp-message-updated"},{"title":"whatsapp.user.preferences","sidebarTitle":"user.preferences","href":"/es/api-reference/webhook-reference/whatsapp-user-preferences"}]},{"group":"WhatsApp templates","pages":[{"title":"whatsapp.template.category_updated","sidebarTitle":"category_updated","href":"/es/api-reference/webhook-reference/whatsapp-template-category-updated"},{"title":"whatsapp.template.correct_category_detection","sidebarTitle":"correct_category_detection","href":"/es/api-reference/webhook-reference/whatsapp-template-correct-category-detection"},{"title":"whatsapp.template.quality_updated","sidebarTitle":"quality_updated","href":"/es/api-reference/webhook-reference/whatsapp-template-quality-updated"},{"title":"whatsapp.template.reviewed","sidebarTitle":"reviewed","href":"/es/api-reference/webhook-reference/whatsapp-template-reviewed"}]},{"group":"WhatsApp accounts","pages":[{"title":"whatsapp.business_account.deleted","sidebarTitle":"deleted","href":"/es/api-reference/webhook-reference/whatsapp-business-account-deleted"},{"title":"whatsapp.business_account.reviewed","sidebarTitle":"reviewed","href":"/es/api-reference/webhook-reference/whatsapp-business-account-reviewed"},{"title":"whatsapp.business_account.updated","sidebarTitle":"actualizado","href":"/es/api-reference/webhook-reference/whatsapp-business-account-updated"}]},{"group":"WhatsApp phone numbers","pages":[{"title":"whatsapp.phone_number.deleted","sidebarTitle":"eliminado","href":"/es/api-reference/webhook-reference/whatsapp-phone-number-deleted"},{"title":"whatsapp.phone_number.name_updated","sidebarTitle":"name_updated","href":"/es/api-reference/webhook-reference/whatsapp-phone-number-name-updated"},{"title":"whatsapp.phone_number.quality_updated","sidebarTitle":"quality_updated","href":"/es/api-reference/webhook-reference/whatsapp-phone-number-quality-updated"},{"title":"whatsapp.phone_number.business_username_updated","sidebarTitle":"business_username_updated","href":"/es/api-reference/webhook-reference/whatsapp-phone-number-business-username-updated"}]},{"group":"WhatsApp Business App","pages":[{"title":"whatsapp.smb.history","sidebarTitle":"smb.history","href":"/es/api-reference/webhook-reference/whatsapp-smb-history"},{"title":"whatsapp.smb.message.created","sidebarTitle":"smb.message.created","href":"/es/api-reference/webhook-reference/whatsapp-smb-message-created"},{"title":"whatsapp.smb.message.echoes","sidebarTitle":"smb.message.echoes","href":"/es/api-reference/webhook-reference/whatsapp-smb-message-echoes"}]},{"group":"WhatsApp Agents","pages":[{"title":"whatsapp.echo_message.created","sidebarTitle":"echo_message.created","href":"/es/api-reference/webhook-reference/whatsapp-echo-message-created"},{"title":"whatsapp.echo_message.updated","sidebarTitle":"echo_message.updated","href":"/es/api-reference/webhook-reference/whatsapp-echo-message-updated"},{"title":"whatsapp.meta_business_agent.handover.updated","sidebarTitle":"meta_business_agent.handover.updated","href":"/es/api-reference/webhook-reference/whatsapp-meta-business-agent-handover-updated"}]},{"group":"WhatsApp calls","pages":[{"title":"whatsapp.call.connect","sidebarTitle":"call.connect","href":"/es/api-reference/webhook-reference/whatsapp-call-connect"},{"title":"whatsapp.call.terminate","sidebarTitle":"call.terminate","href":"/es/api-reference/webhook-reference/whatsapp-call-terminate"},{"title":"whatsapp.call.status.updated","sidebarTitle":"call.status.updated","href":"/es/api-reference/webhook-reference/whatsapp-call-status-updated"},{"title":"whatsapp.call.recording.updated","sidebarTitle":"call.recording.updated","href":"/es/api-reference/webhook-reference/whatsapp-call-recording-updated"},{"title":"whatsapp.call.transcription.updated","sidebarTitle":"call.transcription.updated","href":"/es/api-reference/webhook-reference/whatsapp-call-transcription-updated"}]},{"group":"WhatsApp groups","pages":[{"title":"whatsapp.group.lifecycle_update","sidebarTitle":"lifecycle_update","href":"/es/api-reference/webhook-reference/whatsapp-group-lifecycle-update"},{"title":"whatsapp.group.participants_update","sidebarTitle":"participants_update","href":"/es/api-reference/webhook-reference/whatsapp-group-participants-update"},{"title":"whatsapp.group.settings_update","sidebarTitle":"settings_update","href":"/es/api-reference/webhook-reference/whatsapp-group-settings-update"},{"title":"whatsapp.group.status_update","sidebarTitle":"status_update","href":"/es/api-reference/webhook-reference/whatsapp-group-status-update"}]},{"group":"WhatsApp Flows and payments","pages":[{"title":"whatsapp.flow.status_change","sidebarTitle":"flow.status_change","href":"/es/api-reference/webhook-reference/whatsapp-flow-status-change"},{"title":"whatsapp.payment.updated","sidebarTitle":"payment.updated","href":"/es/api-reference/webhook-reference/whatsapp-payment-updated"}]},{"group":"Contacts","pages":[{"title":"contact.attributes_changed","sidebarTitle":"attributes_changed","href":"/es/api-reference/webhook-reference/contact-attributes-changed"},{"title":"contact.created","sidebarTitle":"created","href":"/es/api-reference/webhook-reference/contact-created"},{"title":"contact.deleted","sidebarTitle":"eliminado","href":"/es/api-reference/webhook-reference/contact-deleted"},{"title":"contact.unsubscribe.created","sidebarTitle":"unsubscribe.created","href":"/es/api-reference/webhook-reference/contact-unsubscribe-created"},{"title":"contact.unsubscribe.deleted","sidebarTitle":"unsubscribe.deleted","href":"/es/api-reference/webhook-reference/contact-unsubscribe-deleted"},{"title":"contact.note.created","sidebarTitle":"note.created","href":"/es/api-reference/webhook-reference/contact-note-created"},{"title":"contact.note.updated","sidebarTitle":"note.updated","href":"/es/api-reference/webhook-reference/contact-note-updated"},{"title":"contact.note.deleted","sidebarTitle":"note.deleted","href":"/es/api-reference/webhook-reference/contact-note-deleted"}]},{"group":"Email, SMS, and Voice","pages":[{"title":"email.delivery.updated","sidebarTitle":"email.delivery.updated","href":"/es/api-reference/webhook-reference/email-delivery-updated"},{"title":"sms.message.updated","sidebarTitle":"sms.message.updated","href":"/es/api-reference/webhook-reference/sms-message-updated"},{"title":"sms.inbound.received","sidebarTitle":"sms.inbound.received","href":"/es/api-reference/webhook-reference/sms-inbound-received"},{"title":"voice.message.updated","sidebarTitle":"voice.message.updated","href":"/es/api-reference/webhook-reference/voice-message-updated"}]}]}]},{"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":"Changelog da API","href":"/pt/api-reference/getting-started/changelog"},{"title":"YCloud Developer Kit","href":"/pt/api-reference/getting-started/ycloud-developer-kit"}]},{"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":"Lidar com 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 (Max Price)","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","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":"Fazer a implantação com segurança","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":"Visão geral dos exemplos","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"}]},{"title":"Exemplos de Webhook","href":"/pt/api-reference/webhook-reference/overview"}]}]},{"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","description":"Submits one representative message sample to Meta and returns its detected category.\nWe recommend submitting 3–4 samples that cover your utility use cases, one per request.\nThis request does not send a message to a recipient.\n\nUtility Direct Send is in public beta. You do not need to join an allowlist or apply for access.\nUse an API key for the YCloud account that manages the specified WhatsApp Business Account.\n\nSamples support text, an interactive CTA URL button, or interactive reply buttons.\nSee [Utility Direct Send](/en/api-reference/guides/whatsapp-platform/best-practices/direct-send)\nfor limits, sending examples, and template conversion.","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","description":"Retrieves a locally stored outbound record scoped by authenticated tenant and from.\nDoes not query Meta or require the Page to remain connected. There is no inbound\ndetail lookup or public message-history list in this phase.\n","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":"Check a Meta contact book entry","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/contactBook/{bsuid}","href":"/api-reference/whatsapp-phone-numbers/check-a-meta-contact-book-entry"},{"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","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/templates","href":"/api-reference/whatsapp-templates/create-a-template"},{"title":"List templates","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/templates","href":"/api-reference/whatsapp-templates/list-templates"},{"title":"Retrieve WhatsApp template analytics","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/templates/analytics","href":"/api-reference/whatsapp-templates/retrieve-whatsapp-template-analytics"},{"title":"Delete templates by name","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/templates/{wabaId}/{name}","href":"/api-reference/whatsapp-templates/delete-templates-by-name"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/templates/{wabaId}/{name}/{language}","href":"/api-reference/whatsapp-templates/delete-a-template"},{"title":"Edit a template","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/templates/{wabaId}/{name}/{language}","href":"/api-reference/whatsapp-templates/edit-a-template"},{"title":"Retrieve a template","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/templates/{wabaId}/{name}/{language}","href":"/api-reference/whatsapp-templates/retrieve-a-template"}]},{"group":"WhatsApp Flows","pages":[{"title":"Create a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/flows","href":"/api-reference/whatsapp-flows/create-a-flow"},{"title":"List flows","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/flows","href":"/api-reference/whatsapp-flows/list-flows"},{"title":"Update flow metadata","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/flows/{flowId}/metadata","href":"/api-reference/whatsapp-flows/update-flow-metadata"},{"title":"Update flow structure","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/flows/{flowId}/assets","href":"/api-reference/whatsapp-flows/update-flow-structure"},{"title":"Delete a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/flows/{flowId}","href":"/api-reference/whatsapp-flows/delete-a-flow"},{"title":"Retrieve a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/flows/{flowId}","href":"/api-reference/whatsapp-flows/retrieve-a-flow"},{"title":"Publish a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/flows/{flowId}/publish","href":"/api-reference/whatsapp-flows/publish-a-flow"},{"title":"Deprecate a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/flows/{flowId}/deprecate","href":"/api-reference/whatsapp-flows/deprecate-a-flow"},{"title":"generate a web preview URL with this flow.","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/flows/{flowId}/preview","href":"/api-reference/whatsapp-flows/generate-a-web-preview-url-with-this-flow"}]},{"group":"CTWA","pages":[{"title":"Submit a conversion event","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /ctwa/conversionEvents","href":"/api-reference/ctwa/submit-a-conversion-event"},{"title":"Submit conversion events","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /ctwa/conversionEvents/batch","href":"/api-reference/ctwa/submit-conversion-events"}]},{"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":"Webhook reference","pages":[{"group":"Messenger","pages":[{"title":"messenger.inbound_message.received","sidebarTitle":"messenger.inbound_message.received","href":"/pt/api-reference/webhook-reference/messenger-inbound-message-received"},{"title":"messenger.inbound_message.updated","sidebarTitle":"messenger.inbound_message.updated","href":"/pt/api-reference/webhook-reference/messenger-inbound-message-updated"},{"title":"messenger.message.updated","sidebarTitle":"messenger.message.updated","href":"/pt/api-reference/webhook-reference/messenger-message-updated"},{"title":"messenger.message_reaction.updated","sidebarTitle":"messenger.message_reaction.updated","href":"/pt/api-reference/webhook-reference/messenger-message-reaction-updated"}]},{"group":"WhatsApp messages","pages":[{"title":"whatsapp.inbound_message.received","sidebarTitle":"inbound_message.received","href":"/pt/api-reference/webhook-reference/whatsapp-inbound-message-received"},{"title":"whatsapp.message.updated","sidebarTitle":"message.updated","href":"/pt/api-reference/webhook-reference/whatsapp-message-updated"},{"title":"whatsapp.user.preferences","sidebarTitle":"user.preferences","href":"/pt/api-reference/webhook-reference/whatsapp-user-preferences"}]},{"group":"WhatsApp templates","pages":[{"title":"whatsapp.template.category_updated","sidebarTitle":"category_updated","href":"/pt/api-reference/webhook-reference/whatsapp-template-category-updated"},{"title":"whatsapp.template.correct_category_detection","sidebarTitle":"correct_category_detection","href":"/pt/api-reference/webhook-reference/whatsapp-template-correct-category-detection"},{"title":"whatsapp.template.quality_updated","sidebarTitle":"quality_updated","href":"/pt/api-reference/webhook-reference/whatsapp-template-quality-updated"},{"title":"whatsapp.template.reviewed","sidebarTitle":"revisado","href":"/pt/api-reference/webhook-reference/whatsapp-template-reviewed"}]},{"group":"WhatsApp accounts","pages":[{"title":"whatsapp.business_account.deleted","sidebarTitle":"deleted","href":"/pt/api-reference/webhook-reference/whatsapp-business-account-deleted"},{"title":"whatsapp.business_account.reviewed","sidebarTitle":"reviewed","href":"/pt/api-reference/webhook-reference/whatsapp-business-account-reviewed"},{"title":"whatsapp.business_account.updated","sidebarTitle":"atualizado","href":"/pt/api-reference/webhook-reference/whatsapp-business-account-updated"}]},{"group":"WhatsApp phone numbers","pages":[{"title":"whatsapp.phone_number.deleted","sidebarTitle":"deleted","href":"/pt/api-reference/webhook-reference/whatsapp-phone-number-deleted"},{"title":"whatsapp.phone_number.name_updated","sidebarTitle":"name_updated","href":"/pt/api-reference/webhook-reference/whatsapp-phone-number-name-updated"},{"title":"whatsapp.phone_number.quality_updated","sidebarTitle":"quality_updated","href":"/pt/api-reference/webhook-reference/whatsapp-phone-number-quality-updated"},{"title":"whatsapp.phone_number.business_username_updated","sidebarTitle":"business_username_updated","href":"/pt/api-reference/webhook-reference/whatsapp-phone-number-business-username-updated"}]},{"group":"WhatsApp Business App","pages":[{"title":"whatsapp.smb.history","sidebarTitle":"smb.history","href":"/pt/api-reference/webhook-reference/whatsapp-smb-history"},{"title":"whatsapp.smb.message.created","sidebarTitle":"smb.message.created","href":"/pt/api-reference/webhook-reference/whatsapp-smb-message-created"},{"title":"whatsapp.smb.message.echoes","sidebarTitle":"smb.message.echoes","href":"/pt/api-reference/webhook-reference/whatsapp-smb-message-echoes"}]},{"group":"WhatsApp Agents","pages":[{"title":"whatsapp.echo_message.created","sidebarTitle":"echo_message.created","href":"/pt/api-reference/webhook-reference/whatsapp-echo-message-created"},{"title":"whatsapp.echo_message.updated","sidebarTitle":"echo_message.updated","href":"/pt/api-reference/webhook-reference/whatsapp-echo-message-updated"},{"title":"whatsapp.meta_business_agent.handover.updated","sidebarTitle":"meta_business_agent.handover.updated","href":"/pt/api-reference/webhook-reference/whatsapp-meta-business-agent-handover-updated"}]},{"group":"WhatsApp calls","pages":[{"title":"whatsapp.call.connect","sidebarTitle":"call.connect","href":"/pt/api-reference/webhook-reference/whatsapp-call-connect"},{"title":"whatsapp.call.terminate","sidebarTitle":"call.terminate","href":"/pt/api-reference/webhook-reference/whatsapp-call-terminate"},{"title":"whatsapp.call.status.updated","sidebarTitle":"call.status.updated","href":"/pt/api-reference/webhook-reference/whatsapp-call-status-updated"},{"title":"whatsapp.call.recording.updated","sidebarTitle":"call.recording.updated","href":"/pt/api-reference/webhook-reference/whatsapp-call-recording-updated"},{"title":"whatsapp.call.transcription.updated","sidebarTitle":"call.transcription.updated","href":"/pt/api-reference/webhook-reference/whatsapp-call-transcription-updated"}]},{"group":"WhatsApp groups","pages":[{"title":"whatsapp.group.lifecycle_update","sidebarTitle":"lifecycle_update","href":"/pt/api-reference/webhook-reference/whatsapp-group-lifecycle-update"},{"title":"whatsapp.group.participants_update","sidebarTitle":"participants_update","href":"/pt/api-reference/webhook-reference/whatsapp-group-participants-update"},{"title":"whatsapp.group.settings_update","sidebarTitle":"settings_update","href":"/pt/api-reference/webhook-reference/whatsapp-group-settings-update"},{"title":"whatsapp.group.status_update","sidebarTitle":"status_update","href":"/pt/api-reference/webhook-reference/whatsapp-group-status-update"}]},{"group":"WhatsApp Flows and payments","pages":[{"title":"whatsapp.flow.status_change","sidebarTitle":"flow.status_change","href":"/pt/api-reference/webhook-reference/whatsapp-flow-status-change"},{"title":"whatsapp.payment.updated","sidebarTitle":"payment.updated","href":"/pt/api-reference/webhook-reference/whatsapp-payment-updated"}]},{"group":"Contacts","pages":[{"title":"contact.attributes_changed","sidebarTitle":"attributes_changed","href":"/pt/api-reference/webhook-reference/contact-attributes-changed"},{"title":"contact.created","sidebarTitle":"created","href":"/pt/api-reference/webhook-reference/contact-created"},{"title":"contact.deleted","sidebarTitle":"deleted","href":"/pt/api-reference/webhook-reference/contact-deleted"},{"title":"contact.unsubscribe.created","sidebarTitle":"unsubscribe.created","href":"/pt/api-reference/webhook-reference/contact-unsubscribe-created"},{"title":"contact.unsubscribe.deleted","sidebarTitle":"unsubscribe.deleted","href":"/pt/api-reference/webhook-reference/contact-unsubscribe-deleted"},{"title":"contact.note.created","sidebarTitle":"note.created","href":"/pt/api-reference/webhook-reference/contact-note-created"},{"title":"contact.note.updated","sidebarTitle":"note.updated","href":"/pt/api-reference/webhook-reference/contact-note-updated"},{"title":"contact.note.deleted","sidebarTitle":"note.deleted","href":"/pt/api-reference/webhook-reference/contact-note-deleted"}]},{"group":"Email, SMS, and Voice","pages":[{"title":"email.delivery.updated","sidebarTitle":"email.delivery.updated","href":"/pt/api-reference/webhook-reference/email-delivery-updated"},{"title":"sms.message.updated","sidebarTitle":"sms.message.updated","href":"/pt/api-reference/webhook-reference/sms-message-updated"},{"title":"sms.inbound.received","sidebarTitle":"sms.inbound.received","href":"/pt/api-reference/webhook-reference/sms-inbound-received"},{"title":"voice.message.updated","sidebarTitle":"voice.message.updated","href":"/pt/api-reference/webhook-reference/voice-message-updated"}]}]}]},{"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"},{"title":"YCloud Developer Kit","href":"/ru/api-reference/getting-started/ycloud-developer-kit"}]},{"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":"Обзор примеров","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"}]},{"title":"Примеры Webhook","href":"/ru/api-reference/webhook-reference/overview"}]}]},{"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","description":"Submits one representative message sample to Meta and returns its detected category.\nWe recommend submitting 3–4 samples that cover your utility use cases, one per request.\nThis request does not send a message to a recipient.\n\nUtility Direct Send is in public beta. You do not need to join an allowlist or apply for access.\nUse an API key for the YCloud account that manages the specified WhatsApp Business Account.\n\nSamples support text, an interactive CTA URL button, or interactive reply buttons.\nSee [Utility Direct Send](/en/api-reference/guides/whatsapp-platform/best-practices/direct-send)\nfor limits, sending examples, and template conversion.","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","description":"Retrieves a locally stored outbound record scoped by authenticated tenant and from.\nDoes not query Meta or require the Page to remain connected. There is no inbound\ndetail lookup or public message-history list in this phase.\n","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":"Check a Meta contact book entry","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/contactBook/{bsuid}","href":"/api-reference/whatsapp-phone-numbers/check-a-meta-contact-book-entry"},{"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","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/templates","href":"/api-reference/whatsapp-templates/create-a-template"},{"title":"List templates","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/templates","href":"/api-reference/whatsapp-templates/list-templates"},{"title":"Retrieve WhatsApp template analytics","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/templates/analytics","href":"/api-reference/whatsapp-templates/retrieve-whatsapp-template-analytics"},{"title":"Delete templates by name","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/templates/{wabaId}/{name}","href":"/api-reference/whatsapp-templates/delete-templates-by-name"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/templates/{wabaId}/{name}/{language}","href":"/api-reference/whatsapp-templates/delete-a-template"},{"title":"Edit a template","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/templates/{wabaId}/{name}/{language}","href":"/api-reference/whatsapp-templates/edit-a-template"},{"title":"Retrieve a template","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/templates/{wabaId}/{name}/{language}","href":"/api-reference/whatsapp-templates/retrieve-a-template"}]},{"group":"WhatsApp Flows","pages":[{"title":"Create a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/flows","href":"/api-reference/whatsapp-flows/create-a-flow"},{"title":"List flows","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/flows","href":"/api-reference/whatsapp-flows/list-flows"},{"title":"Update flow metadata","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/flows/{flowId}/metadata","href":"/api-reference/whatsapp-flows/update-flow-metadata"},{"title":"Update flow structure","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml patch /whatsapp/flows/{flowId}/assets","href":"/api-reference/whatsapp-flows/update-flow-structure"},{"title":"Delete a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml delete /whatsapp/flows/{flowId}","href":"/api-reference/whatsapp-flows/delete-a-flow"},{"title":"Retrieve a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/flows/{flowId}","href":"/api-reference/whatsapp-flows/retrieve-a-flow"},{"title":"Publish a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/flows/{flowId}/publish","href":"/api-reference/whatsapp-flows/publish-a-flow"},{"title":"Deprecate a flow","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /whatsapp/flows/{flowId}/deprecate","href":"/api-reference/whatsapp-flows/deprecate-a-flow"},{"title":"generate a web preview URL with this flow.","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml get /whatsapp/flows/{flowId}/preview","href":"/api-reference/whatsapp-flows/generate-a-web-preview-url-with-this-flow"}]},{"group":"CTWA","pages":[{"title":"Submit a conversion event","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /ctwa/conversionEvents","href":"/api-reference/ctwa/submit-a-conversion-event"},{"title":"Submit conversion events","deprecated":null,"version":null,"openapi":"/openapi/endpoints/ycloud-api-v2.yaml post /ctwa/conversionEvents/batch","href":"/api-reference/ctwa/submit-conversion-events"}]},{"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":"Webhook reference","pages":[{"group":"Messenger","pages":[{"title":"messenger.inbound_message.received","sidebarTitle":"messenger.inbound_message.received","href":"/ru/api-reference/webhook-reference/messenger-inbound-message-received"},{"title":"messenger.inbound_message.updated","sidebarTitle":"messenger.inbound_message.updated","href":"/ru/api-reference/webhook-reference/messenger-inbound-message-updated"},{"title":"messenger.message.updated","sidebarTitle":"messenger.message.updated","href":"/ru/api-reference/webhook-reference/messenger-message-updated"},{"title":"messenger.message_reaction.updated","sidebarTitle":"messenger.message_reaction.updated","href":"/ru/api-reference/webhook-reference/messenger-message-reaction-updated"}]},{"group":"WhatsApp messages","pages":[{"title":"whatsapp.inbound_message.received","sidebarTitle":"inbound_message.received","href":"/ru/api-reference/webhook-reference/whatsapp-inbound-message-received"},{"title":"whatsapp.message.updated","sidebarTitle":"message.updated","href":"/ru/api-reference/webhook-reference/whatsapp-message-updated"},{"title":"whatsapp.user.preferences","sidebarTitle":"user.preferences","href":"/ru/api-reference/webhook-reference/whatsapp-user-preferences"}]},{"group":"WhatsApp templates","pages":[{"title":"whatsapp.template.category_updated","sidebarTitle":"category_updated","href":"/ru/api-reference/webhook-reference/whatsapp-template-category-updated"},{"title":"whatsapp.template.correct_category_detection","sidebarTitle":"correct_category_detection","href":"/ru/api-reference/webhook-reference/whatsapp-template-correct-category-detection"},{"title":"whatsapp.template.quality_updated","sidebarTitle":"quality_updated","href":"/ru/api-reference/webhook-reference/whatsapp-template-quality-updated"},{"title":"whatsapp.template.reviewed","sidebarTitle":"reviewed","href":"/ru/api-reference/webhook-reference/whatsapp-template-reviewed"}]},{"group":"WhatsApp accounts","pages":[{"title":"whatsapp.business_account.deleted","sidebarTitle":"удалено","href":"/ru/api-reference/webhook-reference/whatsapp-business-account-deleted"},{"title":"whatsapp.business_account.reviewed","sidebarTitle":"проверено","href":"/ru/api-reference/webhook-reference/whatsapp-business-account-reviewed"},{"title":"whatsapp.business_account.updated","sidebarTitle":"updated","href":"/ru/api-reference/webhook-reference/whatsapp-business-account-updated"}]},{"group":"WhatsApp phone numbers","pages":[{"title":"whatsapp.phone_number.deleted","sidebarTitle":"deleted","href":"/ru/api-reference/webhook-reference/whatsapp-phone-number-deleted"},{"title":"whatsapp.phone_number.name_updated","sidebarTitle":"name_updated","href":"/ru/api-reference/webhook-reference/whatsapp-phone-number-name-updated"},{"title":"whatsapp.phone_number.quality_updated","sidebarTitle":"quality_updated","href":"/ru/api-reference/webhook-reference/whatsapp-phone-number-quality-updated"},{"title":"whatsapp.phone_number.business_username_updated","sidebarTitle":"business_username_updated","href":"/ru/api-reference/webhook-reference/whatsapp-phone-number-business-username-updated"}]},{"group":"WhatsApp Business App","pages":[{"title":"whatsapp.smb.history","sidebarTitle":"smb.history","href":"/ru/api-reference/webhook-reference/whatsapp-smb-history"},{"title":"whatsapp.smb.message.created","sidebarTitle":"smb.message.created","href":"/ru/api-reference/webhook-reference/whatsapp-smb-message-created"},{"title":"whatsapp.smb.message.echoes","sidebarTitle":"smb.message.echoes","href":"/ru/api-reference/webhook-reference/whatsapp-smb-message-echoes"}]},{"group":"WhatsApp Agents","pages":[{"title":"whatsapp.echo_message.created","sidebarTitle":"echo_message.created","href":"/ru/api-reference/webhook-reference/whatsapp-echo-message-created"},{"title":"whatsapp.echo_message.updated","sidebarTitle":"echo_message.updated","href":"/ru/api-reference/webhook-reference/whatsapp-echo-message-updated"},{"title":"whatsapp.meta_business_agent.handover.updated","sidebarTitle":"meta_business_agent.handover.updated","href":"/ru/api-reference/webhook-reference/whatsapp-meta-business-agent-handover-updated"}]},{"group":"WhatsApp calls","pages":[{"title":"whatsapp.call.connect","sidebarTitle":"call.connect","href":"/ru/api-reference/webhook-reference/whatsapp-call-connect"},{"title":"whatsapp.call.terminate","sidebarTitle":"call.terminate","href":"/ru/api-reference/webhook-reference/whatsapp-call-terminate"},{"title":"whatsapp.call.status.updated","sidebarTitle":"call.status.updated","href":"/ru/api-reference/webhook-reference/whatsapp-call-status-updated"},{"title":"whatsapp.call.recording.updated","sidebarTitle":"call.recording.updated","href":"/ru/api-reference/webhook-reference/whatsapp-call-recording-updated"},{"title":"whatsapp.call.transcription.updated","sidebarTitle":"call.transcription.updated","href":"/ru/api-reference/webhook-reference/whatsapp-call-transcription-updated"}]},{"group":"WhatsApp groups","pages":[{"title":"whatsapp.group.lifecycle_update","sidebarTitle":"lifecycle_update","href":"/ru/api-reference/webhook-reference/whatsapp-group-lifecycle-update"},{"title":"whatsapp.group.participants_update","sidebarTitle":"participants_update","href":"/ru/api-reference/webhook-reference/whatsapp-group-participants-update"},{"title":"whatsapp.group.settings_update","sidebarTitle":"settings_update","href":"/ru/api-reference/webhook-reference/whatsapp-group-settings-update"},{"title":"whatsapp.group.status_update","sidebarTitle":"status_update","href":"/ru/api-reference/webhook-reference/whatsapp-group-status-update"}]},{"group":"WhatsApp Flows and payments","pages":[{"title":"whatsapp.flow.status_change","sidebarTitle":"flow.status_change","href":"/ru/api-reference/webhook-reference/whatsapp-flow-status-change"},{"title":"whatsapp.payment.updated","sidebarTitle":"payment.updated","href":"/ru/api-reference/webhook-reference/whatsapp-payment-updated"}]},{"group":"Contacts","pages":[{"title":"contact.attributes_changed","sidebarTitle":"attributes_changed","href":"/ru/api-reference/webhook-reference/contact-attributes-changed"},{"title":"contact.created","sidebarTitle":"created","href":"/ru/api-reference/webhook-reference/contact-created"},{"title":"contact.deleted","sidebarTitle":"deleted","href":"/ru/api-reference/webhook-reference/contact-deleted"},{"title":"contact.unsubscribe.created","sidebarTitle":"unsubscribe.created","href":"/ru/api-reference/webhook-reference/contact-unsubscribe-created"},{"title":"contact.unsubscribe.deleted","sidebarTitle":"unsubscribe.deleted","href":"/ru/api-reference/webhook-reference/contact-unsubscribe-deleted"},{"title":"contact.note.created","sidebarTitle":"note.created","href":"/ru/api-reference/webhook-reference/contact-note-created"},{"title":"contact.note.updated","sidebarTitle":"note.updated","href":"/ru/api-reference/webhook-reference/contact-note-updated"},{"title":"contact.note.deleted","sidebarTitle":"note.deleted","href":"/ru/api-reference/webhook-reference/contact-note-deleted"}]},{"group":"Email, SMS, and Voice","pages":[{"title":"email.delivery.updated","sidebarTitle":"email.delivery.updated","href":"/ru/api-reference/webhook-reference/email-delivery-updated"},{"title":"sms.message.updated","sidebarTitle":"sms.message.updated","href":"/ru/api-reference/webhook-reference/sms-message-updated"},{"title":"sms.inbound.received","sidebarTitle":"sms.inbound.received","href":"/ru/api-reference/webhook-reference/sms-inbound-received"},{"title":"voice.message.updated","sidebarTitle":"voice.message.updated","href":"/ru/api-reference/webhook-reference/voice-message-updated"}]}]}]},{"tab":"Партнерский центр","icon":"handshake","pages":[{"title":"Партнерский центр","href":"/ru/partner-center/overview"}]}]}]},"basePath":"","title":"Send a Messenger text reply directly - YCloud Docs","buildId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","deploymentId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BFmjTMeT.js","utils-BWr-sjpP.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-LafIDf0N.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-MJNzuxek.js","snippetPresets-DPZEtUvW.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DQ2UhGIs.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DUUJTUkE.js","shallow-BTf5bw35.js","getApiPlaygroundDisplay-h2POYYOO.js","CodeSnippet-C4qEftRe.js","CodeSnippets-CsSrOqMC.js","Page-CWFqNdGh.js","getPastedJson-DU6W6y78.js","icon-2ZYNQ78y.js","MethodPill-BMXJzYMm.js","DuplicateIcon-DNjdEpYZ.js","createIcon-WdPVhKxl.js","DynamicMarkdown-Z_y464fM.js","SectionHeading-Bcrd8azU.js","axios-vUo_bRtp.js","Markdown-BnvucbFu.js","dist-D7YyC486.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-D1I8TPjt.js"]}