This section mirrors the instance related API groups from Instance through Events. The reference includes 46 operations across instance management, messages, chats, groups, business features, templates, settings, proxies, labels, calls, and events.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"WTOCRM User Guide","colors":{"primary":"#15803D","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/wtocrm/Dk9dsuVH2v168f7Y/logo/light.svg?fit=max\u0026auto=format\u0026n=Dk9dsuVH2v168f7Y\u0026q=85\u0026s=41e4f339c4bf499767c289c1a56c637f","dark":"https://mintcdn.com/wtocrm/Dk9dsuVH2v168f7Y/logo/dark.svg?fit=max\u0026auto=format\u0026n=Dk9dsuVH2v168f7Y\u0026q=85\u0026s=87d26cd478e2edada72b99177f52562e"},"favicon":"https://mintcdn.com/wtocrm/PUbgDCiOVj7AitpA/favicon.svg?fit=max\u0026auto=format\u0026n=PUbgDCiOVj7AitpA\u0026q=85\u0026s=43bcf40769d6c65fbdfe32e6f671e7ed","navbar":{"links":[{"href":"https://wtocrm.com","label":"WTOCRM"}],"primary":{"type":"button","label":"Open WTOCRM","href":"https://wtocrm.com"}},"seo":{"indexing":"all"},"contextual":{"options":["copy","chatgpt","claude","perplexity"],"display":"header"},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":""},{"language":"zh-Hans","href":"zh-Hans"},{"language":"pt-BR","href":"pt-BR"},{"language":"es","href":"es"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"wtocrm","hasAudioNarration":false,"actualSubdomain":"wtocrm","customDomains":["docs.wtocrm.com"],"gitSource":{"type":"github","owner":"henrybill6688","repo":"wtocrm-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aea06dfeceed668c0271da2","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"en","tag":"WTO WA API","count":47},{"language":"es","tag":"WTO WA API","count":47},{"language":"pt-BR","tag":"WTO WA API","count":47},{"language":"zh-Hans","tag":"WTO WA API","count":47},{"language":"en","tag":"User guide","count":40},{"language":"es","tag":"Guía del usuario","count":40},{"language":"pt-BR","tag":"Guia do usuário","count":40},{"language":"zh-Hans","tag":"用户指南","count":40},{"language":"en","tag":"Configure your workspace","count":10},{"language":"es","tag":"Configura tu espacio de trabajo","count":10},{"language":"pt-BR","tag":"Configure seu espaço de trabalho","count":10},{"language":"zh-Hans","tag":"配置工作区","count":10},{"language":"en","tag":"Chat","count":9},{"language":"en","tag":"Message","count":9},{"language":"es","tag":"Chats","count":9},{"language":"es","tag":"Mensajes","count":9},{"language":"pt-BR","tag":"Conversas","count":9},{"language":"pt-BR","tag":"Mensagem","count":9},{"language":"zh-Hans","tag":"聊天","count":9},{"language":"zh-Hans","tag":"消息","count":9},{"language":"en","tag":"Connect channels","count":8},{"language":"en","tag":"Instance","count":8},{"language":"es","tag":"Conecta canales","count":8},{"language":"es","tag":"Instancia","count":8},{"language":"pt-BR","tag":"Conecte canais","count":8},{"language":"pt-BR","tag":"Instância","count":8},{"language":"zh-Hans","tag":"连接渠道","count":8},{"language":"zh-Hans","tag":"实例","count":8},{"language":"en","tag":"Blog","count":6},{"language":"en","tag":"Serve customers","count":6},{"language":"es","tag":"Blog","count":6},{"language":"es","tag":"Atiende a tus clientes","count":6},{"language":"pt-BR","tag":"Blog","count":6},{"language":"pt-BR","tag":"Atenda clientes","count":6},{"language":"zh-Hans","tag":"博客","count":6},{"language":"zh-Hans","tag":"服务客户","count":6},{"language":"en","tag":"Start here","count":5},{"language":"es","tag":"Empieza aquí","count":5},{"language":"pt-BR","tag":"Comece aqui","count":5},{"language":"zh-Hans","tag":"从这里开始","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"llms-txt-v2","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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#footer{display:none!important}"}],"page":{"pagePath":"waapi/index","slug":"/waapi/index","pageMetadata":{"title":"WTO WA API","description":"WhatsApp instance API reference.","href":"/waapi/index"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"WhatsApp instance API reference.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`1`,id:`wto-wa-api`,children:`WTO WA API`}),`\n`,_jsx(_components.p,{children:`This section mirrors the instance related API groups from Instance through Events. The reference includes 46 operations across instance management, messages, chats, groups, business features, templates, settings, proxies, labels, calls, and events.`}),`\n`,_jsx(Heading,{level:`2`,id:`instance`,children:`Instance`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.a,{href:`/waapi/connect-instance`,children:`Connect instance: QR code and pairing code`}),`, `,_jsx(_components.a,{href:`/waapi/get-connection-state`,children:`Get Connection State`}),`, `,_jsx(_components.a,{href:`/waapi/create-instance`,children:`Create Instance`}),`, `,_jsx(_components.a,{href:`/waapi/delete-instance`,children:`Delete Instance`}),`, `,_jsx(_components.a,{href:`/waapi/fetch-all-instances`,children:`Fetch All Instances`}),`, `,_jsx(_components.a,{href:`/waapi/logout-instance`,children:`Logout Instance`}),`, `,_jsx(_components.a,{href:`/waapi/restart-instance`,children:`Restart Instance`}),`, `,_jsx(_components.a,{href:`/waapi/set-presence`,children:`Set Presence`})]}),`\n`,_jsx(Heading,{level:`2`,id:`message`,children:`Message`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.a,{href:`/waapi/send-buttons`,children:`Send Buttons`}),`, `,_jsx(_components.a,{href:`/waapi/send-contact`,children:`Send Contact`}),`, `,_jsx(_components.a,{href:`/waapi/send-list`,children:`Send List`}),`, `,_jsx(_components.a,{href:`/waapi/send-location`,children:`Send Location`}),`, `,_jsx(_components.a,{href:`/waapi/send-media-message`,children:`Send Media Message`}),`, `,_jsx(_components.a,{href:`/waapi/send-poll`,children:`Send Poll`}),`, `,_jsx(_components.a,{href:`/waapi/send-reaction`,children:`Send Reaction`}),`, `,_jsx(_components.a,{href:`/waapi/send-template-message`,children:`Send Template Message`}),`, `,_jsx(_components.a,{href:`/waapi/send-text-message`,children:`Send Text Message`})]}),`\n`,_jsx(Heading,{level:`2`,id:`chat`,children:`Chat`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.a,{href:`/waapi/archive-chat`,children:`Archive Chat`}),`, `,_jsx(_components.a,{href:`/waapi/find-chats`,children:`Find Chats`}),`, `,_jsx(_components.a,{href:`/waapi/find-contacts`,children:`Find Contacts`}),`, `,_jsx(_components.a,{href:`/waapi/find-messages`,children:`Find Messages`}),`, `,_jsx(_components.a,{href:`/waapi/mark-message-as-read`,children:`Mark Message as Read`}),`, `,_jsx(_components.a,{href:`/waapi/update-profile-name`,children:`Update Profile Name`}),`, `,_jsx(_components.a,{href:`/waapi/update-profile-picture`,children:`Update Profile Picture`}),`, `,_jsx(_components.a,{href:`/waapi/update-profile-status`,children:`Update Profile Status`}),`, `,_jsx(_components.a,{href:`/waapi/check-whatsapp-numbers`,children:`Check WhatsApp Numbers`})]}),`\n`,_jsx(Heading,{level:`2`,id:`group`,children:`Group`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.a,{href:`/waapi/create-group`,children:`Create Group`}),`, `,_jsx(_components.a,{href:`/waapi/get-group-info`,children:`Get Group Info`}),`, `,_jsx(_components.a,{href:`/waapi/get-participants`,children:`Get Participants`}),`, `,_jsx(_components.a,{href:`/waapi/update-participant`,children:`Update Participant`})]}),`\n`,_jsx(Heading,{level:`2`,id:`business`,children:`Business`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.a,{href:`/waapi/get-catalog`,children:`Get Catalog`}),`, `,_jsx(_components.a,{href:`/waapi/get-collections`,children:`Get Collections`})]}),`\n`,_jsx(Heading,{level:`2`,id:`template`,children:`Template`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.a,{href:`/waapi/create-template`,children:`Create Template`}),`, `,_jsx(_components.a,{href:`/waapi/delete-template`,children:`Delete Template`}),`, `,_jsx(_components.a,{href:`/waapi/edit-template`,children:`Edit Template`}),`, `,_jsx(_components.a,{href:`/waapi/find-templates`,children:`Find Templates`})]}),`\n`,_jsx(Heading,{level:`2`,id:`settings`,children:`Settings`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.a,{href:`/waapi/get-settings`,children:`Get Settings`}),`, `,_jsx(_components.a,{href:`/waapi/set-settings`,children:`Set Settings`})]}),`\n`,_jsx(Heading,{level:`2`,id:`proxy`,children:`Proxy`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.a,{href:`/waapi/get-proxy`,children:`Get Proxy`}),`, `,_jsx(_components.a,{href:`/waapi/set-proxy`,children:`Set Proxy`})]}),`\n`,_jsx(Heading,{level:`2`,id:`label`,children:`Label`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.a,{href:`/waapi/get-labels`,children:`Get Labels`}),`, `,_jsx(_components.a,{href:`/waapi/handle-label`,children:`Handle Label`})]}),`\n`,_jsx(Heading,{level:`2`,id:`call`,children:`Call`}),`\n`,_jsx(_components.p,{children:_jsx(_components.a,{href:`/waapi/offer-call`,children:`Offer Call`})}),`\n`,_jsx(Heading,{level:`2`,id:`events`,children:`Events`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.a,{href:`/waapi/get-webhook`,children:`Get Webhook`}),`, `,_jsx(_components.a,{href:`/waapi/set-webhook`,children:`Set Webhook`}),`, `,_jsx(_components.a,{href:`/waapi/set-websocket`,children:`Set WebSocket`})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"WTO WA API","description":"WhatsApp instance API reference.","href":"/waapi/index"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"WTO WA API","slug":"wto-wa-api","depth":1,"children":[]},{"title":"Instance","slug":"instance","depth":2,"children":[]},{"title":"Message","slug":"message","depth":2,"children":[]},{"title":"Chat","slug":"chat","depth":2,"children":[]},{"title":"Group","slug":"group","depth":2,"children":[]},{"title":"Business","slug":"business","depth":2,"children":[]},{"title":"Template","slug":"template","depth":2,"children":[]},{"title":"Settings","slug":"settings","depth":2,"children":[]},{"title":"Proxy","slug":"proxy","depth":2,"children":[]},{"title":"Label","slug":"label","depth":2,"children":[]},{"title":"Call","slug":"call","depth":2,"children":[]},{"title":"Events","slug":"events","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"wtocrm","siteName":"WTOCRM User Guide","title":"WTO WA API - WTOCRM User Guide","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/waapi","matchLevel":2},"zh-Hans":{"href":"/zh-Hans/waapi/index","matchLevel":1},"pt-BR":{"href":"/pt-BR/waapi/index","matchLevel":1},"es":{"href":"/es/waapi/index","matchLevel":1}}},"lastModified":"2026-10-01T01:33:54.070Z","originalFileLocation":"waapi/index.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=\"WhatsApp instance API reference.\">\u003cmeta data-mint-head name=\"application-name\" content=\"WTOCRM User Guide\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/wtocrm/0slN7rqeAoXIdz01/_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/wtocrm/0slN7rqeAoXIdz01/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/wtocrm/0slN7rqeAoXIdz01/_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/wtocrm/0slN7rqeAoXIdz01/_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/wtocrm/0slN7rqeAoXIdz01/_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/wtocrm/0slN7rqeAoXIdz01/_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/wtocrm/0slN7rqeAoXIdz01/_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/wtocrm/0slN7rqeAoXIdz01/_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/wtocrm/0slN7rqeAoXIdz01/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"WTO WA API - WTOCRM User Guide\">\u003cmeta data-mint-head property=\"og:description\" content=\"WhatsApp instance API reference.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"WTOCRM User Guide\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.wtocrm.com/waapi\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://wtocrm.mintlify.site/_mintlify/api/og/v2?division=WhatsApp+API\u0026amp;title=WTO+WA+API\u0026amp;description=WhatsApp+instance+API+reference.\u0026amp;theme=aefeee4a5d31687a9900e017\u0026amp;signature=57237c180fa1eedeb5346a144910687ac6a21387fd9d1d4ac10a05ed3e03ee4d\">\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=\"WTO WA API - WTOCRM User Guide\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"WhatsApp instance API reference.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://wtocrm.mintlify.site/_mintlify/api/og/v2?division=WhatsApp+API\u0026amp;title=WTO+WA+API\u0026amp;description=WhatsApp+instance+API+reference.\u0026amp;theme=aefeee4a5d31687a9900e017\u0026amp;signature=57237c180fa1eedeb5346a144910687ac6a21387fd9d1d4ac10a05ed3e03ee4d\">\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/wtocrm/0slN7rqeAoXIdz01/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"WTOCRM User Guide\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#15803D\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.wtocrm.com/waapi\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/waapi/index.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.wtocrm.com/waapi\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh-Hans\" href=\"https://docs.wtocrm.com/zh-Hans/waapi\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt-BR\" href=\"https://docs.wtocrm.com/pt-BR/waapi\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.wtocrm.com/es/waapi\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.wtocrm.com/waapi\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.wtocrm.com/#organization\",\"name\":\"WTOCRM User Guide\",\"url\":\"https://docs.wtocrm.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/wtocrm/Dk9dsuVH2v168f7Y/logo/light.svg?fit=max\u0026auto=format\u0026n=Dk9dsuVH2v168f7Y\u0026q=85\u0026s=41e4f339c4bf499767c289c1a56c637f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.wtocrm.com#website\",\"name\":\"WTOCRM User Guide\",\"url\":\"https://docs.wtocrm.com\",\"publisher\":{\"@id\":\"https://docs.wtocrm.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.wtocrm.com/waapi#webpage\",\"url\":\"https://docs.wtocrm.com/waapi\",\"name\":\"WTO WA API\",\"description\":\"WhatsApp instance API reference.\",\"dateModified\":\"2026-10-01T01:33:54.070Z\",\"isPartOf\":{\"@id\":\"https://docs.wtocrm.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.wtocrm.com/waapi#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.wtocrm.com/waapi#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"WhatsApp API\",\"item\":\"https://docs.wtocrm.com/waapi/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"WTO WA API\",\"item\":\"https://docs.wtocrm.com/waapi\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.wtocrm.com/waapi#article\",\"headline\":\"WTO WA API\",\"name\":\"WTO WA API\",\"description\":\"WhatsApp instance API reference.\",\"url\":\"https://docs.wtocrm.com/waapi\",\"mainEntityOfPage\":{\"@id\":\"https://docs.wtocrm.com/waapi#webpage\"},\"dateModified\":\"2026-10-01T01:33:54.070Z\",\"publisher\":{\"@id\":\"https://docs.wtocrm.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.wtocrm.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"WTOCRM User Guide\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"WTOCRM User Guide","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"User guide","icon":"book-open","pages":[{"title":"User guide","href":""}]},{"tab":"WTO WA API","icon":"message-circle","groups":[{"group":"WhatsApp API","pages":[{"title":"WTO WA API","href":"/waapi"}]},{"group":"Instance","pages":[{"title":"Connect instance: QR code and pairing code","description":"Log in to WhatsApp with a QR code or phone-number pairing code, then verify the instance connection.","openapi":"api-reference/openapi/WTO-WA-API/instance.yaml GET /instance/connect/{instanceName}","href":"/waapi/connect-instance"},{"title":"Get Connection State","openapi":"api-reference/openapi/WTO-WA-API/instance.yaml GET /instance/connectionState/{instanceName}","href":"/waapi/get-connection-state"},{"title":"Create Instance","openapi":"api-reference/openapi/WTO-WA-API/instance.yaml POST /instance/create","href":"/waapi/create-instance"},{"title":"Delete Instance","openapi":"api-reference/openapi/WTO-WA-API/instance.yaml DELETE /instance/delete/{instanceName}","href":"/waapi/delete-instance"},{"title":"Fetch All Instances","openapi":"api-reference/openapi/WTO-WA-API/instance.yaml GET /instance/fetchInstances","href":"/waapi/fetch-all-instances"},{"title":"Logout Instance","openapi":"api-reference/openapi/WTO-WA-API/instance.yaml DELETE /instance/logout/{instanceName}","href":"/waapi/logout-instance"},{"title":"Restart Instance","openapi":"api-reference/openapi/WTO-WA-API/instance.yaml POST /instance/restart/{instanceName}","href":"/waapi/restart-instance"},{"title":"Set Presence","openapi":"api-reference/openapi/WTO-WA-API/instance.yaml POST /instance/setPresence/{instanceName}","href":"/waapi/set-presence"}]},{"group":"Message","pages":[{"title":"Send Buttons","openapi":"api-reference/openapi/WTO-WA-API/message.yaml POST /message/sendButtons/{instanceName}","href":"/waapi/send-buttons"},{"title":"Send Contact","openapi":"api-reference/openapi/WTO-WA-API/message.yaml POST /message/sendContact/{instanceName}","href":"/waapi/send-contact"},{"title":"Send List","openapi":"api-reference/openapi/WTO-WA-API/message.yaml POST /message/sendList/{instanceName}","href":"/waapi/send-list"},{"title":"Send Location","openapi":"api-reference/openapi/WTO-WA-API/message.yaml POST /message/sendLocation/{instanceName}","href":"/waapi/send-location"},{"title":"Send Media Message","openapi":"api-reference/openapi/WTO-WA-API/message.yaml POST /message/sendMedia/{instanceName}","href":"/waapi/send-media-message"},{"title":"Send Poll","openapi":"api-reference/openapi/WTO-WA-API/message.yaml POST /message/sendPoll/{instanceName}","href":"/waapi/send-poll"},{"title":"Send Reaction","openapi":"api-reference/openapi/WTO-WA-API/message.yaml POST /message/sendReaction/{instanceName}","href":"/waapi/send-reaction"},{"title":"Send Template Message","openapi":"api-reference/openapi/WTO-WA-API/message.yaml POST /message/sendTemplate/{instanceName}","href":"/waapi/send-template-message"},{"title":"Send Text Message","openapi":"api-reference/openapi/WTO-WA-API/message.yaml POST /message/sendText/{instanceName}","href":"/waapi/send-text-message"}]},{"group":"Chat","pages":[{"title":"Archive Chat","openapi":"api-reference/openapi/WTO-WA-API/chat.yaml POST /chat/archiveChat/{instanceName}","href":"/waapi/archive-chat"},{"title":"Find Chats","openapi":"api-reference/openapi/WTO-WA-API/chat.yaml POST /chat/findChats/{instanceName}","href":"/waapi/find-chats"},{"title":"Find Contacts","openapi":"api-reference/openapi/WTO-WA-API/chat.yaml POST /chat/findContacts/{instanceName}","href":"/waapi/find-contacts"},{"title":"Find Messages","openapi":"api-reference/openapi/WTO-WA-API/chat.yaml POST /chat/findMessages/{instanceName}","href":"/waapi/find-messages"},{"title":"Mark Message as Read","openapi":"api-reference/openapi/WTO-WA-API/chat.yaml POST /chat/markMessageAsRead/{instanceName}","href":"/waapi/mark-message-as-read"},{"title":"Update Profile Name","openapi":"api-reference/openapi/WTO-WA-API/chat.yaml POST /chat/updateProfileName/{instanceName}","href":"/waapi/update-profile-name"},{"title":"Update Profile Picture","openapi":"api-reference/openapi/WTO-WA-API/chat.yaml POST /chat/updateProfilePicture/{instanceName}","href":"/waapi/update-profile-picture"},{"title":"Update Profile Status","openapi":"api-reference/openapi/WTO-WA-API/chat.yaml POST /chat/updateProfileStatus/{instanceName}","href":"/waapi/update-profile-status"},{"title":"Check WhatsApp Numbers","openapi":"api-reference/openapi/WTO-WA-API/chat.yaml POST /chat/whatsappNumbers/{instanceName}","href":"/waapi/check-whatsapp-numbers"}]},{"group":"Group","pages":[{"title":"Create Group","openapi":"api-reference/openapi/WTO-WA-API/group.yaml POST /group/create/{instanceName}","href":"/waapi/create-group"},{"title":"Get Group Info","openapi":"api-reference/openapi/WTO-WA-API/group.yaml GET /group/findGroupInfos/{instanceName}","href":"/waapi/get-group-info"},{"title":"Get Participants","openapi":"api-reference/openapi/WTO-WA-API/group.yaml GET /group/participants/{instanceName}","href":"/waapi/get-participants"},{"title":"Update Participant","openapi":"api-reference/openapi/WTO-WA-API/group.yaml POST /group/updateParticipant/{instanceName}","href":"/waapi/update-participant"}]},{"group":"Business","pages":[{"title":"Get Catalog","openapi":"api-reference/openapi/WTO-WA-API/business.yaml POST /business/getCatalog/{instanceName}","href":"/waapi/get-catalog"},{"title":"Get Collections","openapi":"api-reference/openapi/WTO-WA-API/business.yaml POST /business/getCollections/{instanceName}","href":"/waapi/get-collections"}]},{"group":"Template","pages":[{"title":"Create Template","openapi":"api-reference/openapi/WTO-WA-API/template.yaml POST /template/create/{instanceName}","href":"/waapi/create-template"},{"title":"Delete Template","openapi":"api-reference/openapi/WTO-WA-API/template.yaml DELETE /template/delete/{instanceName}","href":"/waapi/delete-template"},{"title":"Edit Template","openapi":"api-reference/openapi/WTO-WA-API/template.yaml POST /template/edit/{instanceName}","href":"/waapi/edit-template"},{"title":"Find Templates","openapi":"api-reference/openapi/WTO-WA-API/template.yaml GET /template/find/{instanceName}","href":"/waapi/find-templates"}]},{"group":"Settings","pages":[{"title":"Get Settings","openapi":"api-reference/openapi/WTO-WA-API/settings.yaml GET /settings/find/{instanceName}","href":"/waapi/get-settings"},{"title":"Set Settings","openapi":"api-reference/openapi/WTO-WA-API/settings.yaml POST /settings/set/{instanceName}","href":"/waapi/set-settings"}]},{"group":"Proxy","pages":[{"title":"Get Proxy","openapi":"api-reference/openapi/WTO-WA-API/proxy.yaml GET /proxy/find/{instanceName}","href":"/waapi/get-proxy"},{"title":"Set Proxy","openapi":"api-reference/openapi/WTO-WA-API/proxy.yaml POST /proxy/set/{instanceName}","href":"/waapi/set-proxy"}]},{"group":"Label","pages":[{"title":"Get Labels","openapi":"api-reference/openapi/WTO-WA-API/label.yaml GET /label/findLabels/{instanceName}","href":"/waapi/get-labels"},{"title":"Handle Label","openapi":"api-reference/openapi/WTO-WA-API/label.yaml POST /label/handleLabel/{instanceName}","href":"/waapi/handle-label"}]},{"group":"Call","pages":[{"title":"Offer Call","openapi":"api-reference/openapi/WTO-WA-API/call.yaml POST /call/offer/{instanceName}","href":"/waapi/offer-call"}]},{"group":"Events","pages":[{"title":"Get Webhook","openapi":"api-reference/openapi/WTO-WA-API/events.yaml GET /webhook/find/{instanceName}","href":"/waapi/get-webhook"},{"title":"Set Webhook","openapi":"api-reference/openapi/WTO-WA-API/events.yaml POST /webhook/set/{instanceName}","href":"/waapi/set-webhook"},{"title":"Set WebSocket","openapi":"api-reference/openapi/WTO-WA-API/events.yaml POST /websocket/set/{instanceName}","href":"/waapi/set-websocket"}]}]},{"tab":"Blog","icon":"newspaper","pages":[{"title":"Blog","href":"/blog"}]}]},{"language":"zh-Hans","pages":[{"title":"zh-Hans","href":"/zh-Hans/waapi"}]},{"language":"pt-BR","pages":[{"title":"pt-BR","href":"/pt-BR/waapi"}]},{"language":"es","pages":[{"title":"es","href":"/es/waapi"}]}]},"basePath":"","title":"WTO WA API - WTOCRM User Guide","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":[],"chunks":[]}
