Configurações de privacidade do aplicativo via API
Conceituação
Neste tópico você vai conhecer todos os métodos disponíveis para configurações de privacidade.As configurações de privacidade do aplicativo são um conjunto de opções e recursos que permitem aos usuários controlar quem pode acessar suas informações pessoais e interagir com eles no aplicativo de mensagens. Essas configurações visam proteger a privacidade dos usuários e oferecer controle sobre o compartilhamento de informações. Os principais elementos das configurações de privacidade incluem a possibilidade de definir quem pode ver sua foto de perfil, informações de visto por último e confirmar a leitura de mensagens.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/schema.json","name":"Z-API Docs","colors":{"primary":"#00B140","light":"#00D455","dark":"#007A2C"},"logo":{"light":"https://staging.z-api.io/logos/SVG/Ativo%2016.svg","dark":"https://staging.z-api.io/logos/SVG/Ativo%2016.svg"},"favicon":"https://mintcdn.com/z-api-8aa3bb40/5Sj9mIPH3KokDXt2/favicon.png?fit=max\u0026auto=format\u0026n=5Sj9mIPH3KokDXt2\u0026q=85\u0026s=0ee09d9d5aa6a2ffd98d0e3a7335da05","api":{"examples":{"defaults":"required"},"mdx":{"auth":{"method":"key","name":"Client-Token"},"server":"https://api.z-api.io"}},"background":{"color":{"dark":"#14161f"}},"styling":{"codeblocks":{"theme":{"light":"github-light","dark":"poimandres"}},"latex":false},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://www.z-api.io/blog"},{"anchor":"YouTube","icon":"youtube","href":"https://www.youtube.com/@z_api"},{"anchor":"Postman","icon":"rocket","href":"https://www.postman.com/docs-z-api/z-api-s-public-workspace/collection/gwri249/z-api-collection"},{"anchor":"Comunidade","icon":"whatsapp","href":"https://chat.whatsapp.com/KmE3atZGmWJEspMZnBZKjV"}]},"languages":[{"language":"pt-BR","default":true,"navbar":{"links":[{"href":"https://api.whatsapp.com/send?phone=554431421722\u0026text=Ol%C3%A1,%20gostaria%20de%20falar%20com%20o%20suporte%20da%20Z-API","label":"Suporte"}],"primary":{"type":"button","label":"Painel","href":"https://app.z-api.io/"}},"href":"quickstart/introduction"},{"language":"en","navbar":{"links":[{"href":"https://api.whatsapp.com/send?phone=554431421722\u0026text=Hello,%20I%20would%20like%20to%20talk%20to%20Z-API%20support","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.z-api.io/"}},"href":"en/quickstart/introduction"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"z-api-8aa3bb40","hasAudioNarration":false,"actualSubdomain":"z-api-8aa3bb40","customDomains":["developer.z-api.io"],"gitSource":{"type":"github","owner":"z-api","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6aea4890ca1163ccfe95edea","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"pt-BR","tag":"API Reference","count":499},{"language":"en","tag":"API Reference","count":499},{"language":"pt-BR","tag":"Messages","count":42},{"language":"en","tag":"Messages","count":42},{"language":"pt-BR","tag":"Aplicativo Business","count":32},{"language":"en","tag":"Business application","count":32},{"language":"pt-BR","tag":"Groups","count":23},{"language":"en","tag":"Groups","count":23},{"language":"pt-BR","tag":"Instance","count":22},{"language":"en","tag":"Instance","count":22},{"language":"pt-BR","tag":"Documentação","count":21},{"language":"en","tag":"Documentation","count":21},{"language":"pt-BR","tag":"Newsletter","count":19},{"language":"en","tag":"Newsletter","count":19},{"language":"pt-BR","tag":"Mobile","count":16},{"language":"en","tag":"Mobile","count":16},{"language":"pt-BR","tag":"Communities","count":14},{"language":"pt-BR","tag":"Webhooks","count":14},{"language":"en","tag":"Communities","count":14},{"language":"en","tag":"Webhooks","count":14}]},"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"privacy/introduction","slug":"/privacy/introduction","pageMetadata":{"title":"Introdução","description":"Configurações de privacidade do aplicativo via API","href":"/privacy/introduction"},"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: \"Configurações de privacidade do aplicativo via API\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`conceituação`,children:`Conceituação`}),`\n`,_jsx(_components.p,{children:`Neste tópico você vai conhecer todos os métodos disponíveis para configurações de privacidade.`}),`\n`,_jsxs(_components.p,{children:[`As `,_jsx(_components.strong,{children:`configurações de privacidade`}),` do aplicativo são um conjunto de opções e recursos que permitem aos usuários controlar quem pode acessar suas informações pessoais e interagir com eles no aplicativo de mensagens. Essas configurações visam proteger a privacidade dos usuários e oferecer controle sobre o compartilhamento de informações. Os principais elementos das configurações de privacidade incluem a possibilidade de definir quem pode ver sua `,_jsx(_components.strong,{children:`foto de perfil`}),`, informações de `,_jsx(_components.strong,{children:`visto por último`}),` e `,_jsx(_components.strong,{children:`confirmar a leitura de mensagens`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light","dark":"poimandres"}},"config":{},"pageMetadata":{"title":"Introdução","description":"Configurações de privacidade do aplicativo via API","href":"/privacy/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Conceituação","slug":"conceituação","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/z-api-8aa3bb40/a56ff8c5f47a412e/gptmaker.js"],"subdomain":"z-api-8aa3bb40","siteName":"Z-API Docs","title":"Introdução - Z-API Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"pt-BR":{"href":"/privacy/introduction","matchLevel":0},"en":{"href":"/en/privacy/introduction","matchLevel":1}}},"lastModified":"2026-10-30T15:07:52.054Z","originalFileLocation":"privacy/introduction.mdx","locale":"pt-BR"},"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=\"Configurações de privacidade do aplicativo via API\">\u003cmeta data-mint-head name=\"application-name\" content=\"Z-API 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/z-api-8aa3bb40/ZpLU815Jzg8ouylX/_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/z-api-8aa3bb40/ZpLU815Jzg8ouylX/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/z-api-8aa3bb40/ZpLU815Jzg8ouylX/_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/z-api-8aa3bb40/ZpLU815Jzg8ouylX/_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/z-api-8aa3bb40/ZpLU815Jzg8ouylX/_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/z-api-8aa3bb40/ZpLU815Jzg8ouylX/_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/z-api-8aa3bb40/ZpLU815Jzg8ouylX/_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/z-api-8aa3bb40/ZpLU815Jzg8ouylX/_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/z-api-8aa3bb40/ZpLU815Jzg8ouylX/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introdução - Z-API Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Configurações de privacidade do aplicativo via API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Z-API Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.z-api.io/privacy/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://z-api-8aa3bb40.mintlify.site/_mintlify/api/og/v2?division=Privacy\u0026amp;title=Introdu%C3%A7%C3%A3o\u0026amp;description=Configura%C3%A7%C3%B5es+de+privacidade+do+aplicativo+via+API\u0026amp;theme=7af4b4b8156034d7138bfc6e\u0026amp;signature=3028c044a1b37fea379d569272212ba92eac1840ac278eedc842d5edf9cf79b3\">\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=\"Introdução - Z-API Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Configurações de privacidade do aplicativo via API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://z-api-8aa3bb40.mintlify.site/_mintlify/api/og/v2?division=Privacy\u0026amp;title=Introdu%C3%A7%C3%A3o\u0026amp;description=Configura%C3%A7%C3%B5es+de+privacidade+do+aplicativo+via+API\u0026amp;theme=7af4b4b8156034d7138bfc6e\u0026amp;signature=3028c044a1b37fea379d569272212ba92eac1840ac278eedc842d5edf9cf79b3\">\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/z-api-8aa3bb40/ZpLU815Jzg8ouylX/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Z-API Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00B140\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.z-api.io/privacy/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/privacy/introduction.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt-BR\" href=\"https://developer.z-api.io/privacy/introduction\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://developer.z-api.io/en/privacy/introduction\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://developer.z-api.io/privacy/introduction\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.z-api.io/#organization\",\"name\":\"Z-API Docs\",\"url\":\"https://developer.z-api.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://staging.z-api.io/logos/SVG/Ativo%2016.svg\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.z-api.io#website\",\"name\":\"Z-API Docs\",\"url\":\"https://developer.z-api.io\",\"publisher\":{\"@id\":\"https://developer.z-api.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.z-api.io/privacy/introduction#webpage\",\"url\":\"https://developer.z-api.io/privacy/introduction\",\"name\":\"Introdução\",\"description\":\"Configurações de privacidade do aplicativo via API\",\"dateModified\":\"2026-10-30T15:07:52.054Z\",\"isPartOf\":{\"@id\":\"https://developer.z-api.io#website\"},\"breadcrumb\":{\"@id\":\"https://developer.z-api.io/privacy/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.z-api.io/privacy/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://developer.z-api.io/instance/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introdução\",\"item\":\"https://developer.z-api.io/privacy/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://developer.z-api.io/privacy/introduction#article\",\"headline\":\"Introdução\",\"name\":\"Introdução\",\"description\":\"Configurações de privacidade do aplicativo via API\",\"url\":\"https://developer.z-api.io/privacy/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://developer.z-api.io/privacy/introduction#webpage\"},\"dateModified\":\"2026-10-30T15:07:52.054Z\",\"publisher\":{\"@id\":\"https://developer.z-api.io/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.z-api.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Z-API Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Z-API Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/privacy/introduction.md","siteName":"Z-API Docs","nav":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://www.z-api.io/blog"},{"anchor":"YouTube","icon":"youtube","href":"https://www.youtube.com/@z_api"},{"anchor":"Postman","icon":"rocket","href":"https://www.postman.com/docs-z-api/z-api-s-public-workspace/collection/gwri249/z-api-collection"},{"anchor":"Comunidade","icon":"whatsapp","href":"https://chat.whatsapp.com/KmE3atZGmWJEspMZnBZKjV"}]},"languages":[{"language":"pt-BR","default":true,"navbar":{"links":[{"href":"https://api.whatsapp.com/send?phone=554431421722\u0026text=Ol%C3%A1,%20gostaria%20de%20falar%20com%20o%20suporte%20da%20Z-API","label":"Suporte"}],"primary":{"type":"button","label":"Painel","href":"https://app.z-api.io/"}},"tabs":[{"tab":"Documentação","pages":[{"title":"Documentação","href":"/quickstart/introduction"}]},{"tab":"API Reference","groups":[{"group":"Visão Geral","pages":[{"title":"Introdução","href":"/api-reference/introduction"}]},{"group":"API Reference","pages":[{"group":"Instance","pages":[{"title":"Introdução","href":"/instance/introduction"},{"title":"Leitura automática","api":"PUT /instances/{instanceId}/token/{token}/update-auto-read-message","href":"/instance/update-auto-read-message"},{"title":"Leitura automática de status","api":"PUT /instances/{instanceId}/token/{token}/update-auto-read-status","href":"/instance/update-auto-read-status"},{"title":"Atualizar imagem de perfil","api":"PUT /instances/{instanceId}/token/{token}/profile-picture","href":"/instance/profile-picture"},{"title":"Atualizar nome do perfil","api":"PUT /instances/{instanceId}/token/{token}/profile-name","href":"/instance/profile-name"},{"title":"Atualizar descrição do perfil","api":"PUT /instances/{instanceId}/token/{token}/profile-description","href":"/instance/profile-description"},{"title":"Rejeitar chamadas","api":"PUT /instances/{instanceId}/token/{token}/update-call-reject-auto","href":"/instance/update-call-reject-auto"},{"title":"Mensagem de ligação","api":"PUT /instances/{instanceId}/token/{token}/update-call-reject-message","href":"/instance/update-call-reject-message"},{"title":"Pegar QRCode","href":"/instance/qrcode"},{"title":"QRCode em bytes","api":"GET /instances/{instanceId}/token/{token}/qr-code","href":"/instance/qr-code"},{"title":"QRCode em imagem","api":"GET /instances/{instanceId}/token/{token}/qr-code/image","href":"/instance/qr-code-image"},{"title":"Concluir o Challenge","api":"POST /instances/{instanceId}/token/{token}/passkey-prologue","href":"/instance/passkey-prologue"},{"title":"Resetar o Challenge","api":"POST /instances/{instanceId}/token/{token}/reset-passkey-challenge","href":"/instance/reset-passkey-challenge"},{"title":"Conectar com telefone","api":"GET /instances/{instanceId}/token/{token}/phone-code/{phone}","href":"/instance/phone-code"},{"title":"Gerar token para extensão","api":"GET /instances/{instanceId}/token/{token}/extension-token","href":"/instance/extension-token"},{"title":"Reiniciar instância","api":"GET /instances/{instanceId}/token/{token}/restart","href":"/instance/restart"},{"title":"Desconectar","api":"GET /instances/{instanceId}/token/{token}/disconnect","href":"/instance/disconnect"},{"title":"Status da instância","api":"GET /instances/{instanceId}/token/{token}/status","href":"/instance/status"},{"title":"Dados do celular","api":"GET /instances/{instanceId}/token/{token}/device","href":"/instance/device"},{"title":"Renomear instância","api":"PUT /instances/{instanceId}/token/{token}/update-name","href":"/instance/rename-instance"},{"title":"Dados da instância","api":"GET /instances/{instanceId}/token/{token}/me","href":"/instance/me"},{"title":"Ativar Proteção de Grupo de Avisos","api":"PUT /instances/{instanceId}/token/{token}/update-announcement-guard","href":"/instance/update-announcement-guard"}]},{"group":"Mobile","pages":[{"title":"Introdução","href":"/mobile/introduction"},{"title":"Verificar disponibilidade","api":"POST /instances/{instanceId}/token/{token}/mobile/registration-available","href":"/mobile/registration-available"},{"title":"Solicitar código de confirmação","api":"POST /instances/{instanceId}/token/{token}/mobile/request-registration-code","href":"/mobile/request-code"},{"title":"Responder captcha","api":"POST /instances/{instanceId}/token/{token}/mobile/respond-captcha","href":"/mobile/captcha-confirm"},{"title":"Confirmar código","api":"POST /instances/{instanceId}/token/{token}/mobile/confirm-registration-code","href":"/mobile/confirm-code"},{"title":"Confirmar transferência no celular","api":"GET /instances/{instanceId}/token/{token}/mobile/device-transfer-confirmed","href":"/mobile/device-transfer-confirmed"},{"title":"Solicitar desbanimento","api":"POST /instances/{instanceId}/token/{token}/mobile/request-unbanning","href":"/mobile/request-unbanning"},{"title":"Confirmar código PIN","api":"POST /instances/{instanceId}/token/{token}/mobile/confirm-pin-code","href":"/mobile/confirm-security-code"},{"title":"Recuperar código PIN","api":"POST /instances/{instanceId}/token/{token}/mobile/recovery-pin-code","href":"/mobile/forgot-security-code"},{"title":"Buscar e-mail da conta","api":"GET /instances/{instanceId}/token/{token}/security/email","href":"/mobile/get-account-email"},{"title":"Cadastrar e-mail na conta","api":"POST /instances/{instanceId}/token/{token}/security/email","href":"/mobile/set-account-email"},{"title":"Verificar e-mail da conta","api":"POST /instances/{instanceId}/token/{token}/security/verify-email","href":"/mobile/verify-account-email"},{"title":"Verificar código PIN","api":"GET /instances/{instanceId}/token/{token}/security/two-fa-code","href":"/mobile/get-has-security-code"},{"title":"Cadastrar código PIN","api":"POST /instances/{instanceId}/token/{token}/security/two-fa-code","href":"/mobile/set-security-code"},{"title":"Remover e-mail da conta","api":"POST /instances/{instanceId}/token/{token}/security/email/remove","href":"/mobile/remove-account-email"},{"title":"Remover código PIN","api":"POST /instances/{instanceId}/token/{token}/security/two-fa-code/remove","href":"/mobile/remove-security-code"}]},{"group":"Messages","pages":[{"title":"Introdução","href":"/message/introduction"},{"title":"Enviar texto simples","api":"POST /instances/{instanceId}/token/{token}/send-text","href":"/message/send-text"},{"title":"Reencaminhar mensagem","api":"POST /instances/{instanceId}/token/{token}/forward-message","href":"/message/forward-message"},{"title":"Enviar reação","api":"POST /instances/{instanceId}/token/{token}/send-reaction","href":"/message/send-message-reaction"},{"title":"Remover reação","api":"POST /instances/{instanceId}/token/{token}/send-remove-reaction","href":"/message/send-remove-reaction"},{"title":"Enviar imagem","api":"POST /instances/{instanceId}/token/{token}/send-image","href":"/message/send-message-image"},{"title":"Enviar sticker","api":"POST /instances/{instanceId}/token/{token}/send-sticker","href":"/message/send-message-sticker"},{"title":"Enviar GIF","api":"POST /instances/{instanceId}/token/{token}/send-gif","href":"/message/send-message-gif"},{"title":"Enviar áudio","api":"POST /instances/{instanceId}/token/{token}/send-audio","href":"/message/send-message-audio"},{"title":"Enviar vídeo","api":"POST /instances/{instanceId}/token/{token}/send-video","href":"/message/send-message-video"},{"title":"Enviar PTV","api":"POST /instances/{instanceId}/token/{token}/send-ptv","href":"/message/send-message-ptv"},{"title":"Enviar documento","api":"POST /instances/{instanceId}/token/{token}/send-document/{extension}","href":"/message/send-message-document"},{"title":"Enviar link","api":"POST /instances/{instanceId}/token/{token}/send-link","href":"/message/send-message-link"},{"title":"Enviar localização","api":"POST /instances/{instanceId}/token/{token}/send-location","href":"/message/send-message-location"},{"title":"Enviar produto","api":"POST /instances/{instanceId}/token/{token}/send-product","href":"/message/send-message-product"},{"title":"Enviar catálogo","api":"POST /instances/{instanceId}/token/{token}/send-catalog","href":"/message/send-message-catalog"},{"title":"Enviar contato","api":"POST /instances/{instanceId}/token/{token}/send-contact","href":"/message/send-message-contact"},{"title":"Enviar múltiplos contatos","api":"POST /instances/{instanceId}/token/{token}/send-contacts","href":"/message/send-message-multiple-contacts"},{"title":"Enviar botões de ação","api":"POST /instances/{instanceId}/token/{token}/send-button-actions","href":"/message/send-button-actions"},{"title":"Enviar lista de botões","api":"POST /instances/{instanceId}/token/{token}/send-button-list","href":"/message/send-button-list"},{"title":"Enviar botões com imagem","api":"POST /instances/{instanceId}/token/{token}/send-button-list","href":"/message/send-button-list-image"},{"title":"Enviar botões com vídeo","api":"POST /instances/{instanceId}/token/{token}/send-button-list","href":"/message/send-button-list-video"},{"title":"Enviar lista de opções","api":"POST /instances/{instanceId}/token/{token}/send-option-list","href":"/message/send-option-list"},{"title":"Enviar botão OTP","api":"POST /instances/{instanceId}/token/{token}/send-button-otp","href":"/message/send-button-otp"},{"title":"Enviar botão PIX","api":"POST /instances/{instanceId}/token/{token}/send-button-pix","href":"/message/send-button-pix"},{"title":"Enviar carrossel","api":"POST /instances/{instanceId}/token/{token}/send-carousel","href":"/message/send-carousel"},{"title":"Deletar mensagens","api":"DELETE /instances/{instanceId}/token/{token}/messages","href":"/message/delete-message"},{"title":"Ler mensagens","api":"POST /instances/{instanceId}/token/{token}/read-message","href":"/message/read-message"},{"title":"Responder mensagem","api":"POST /instances/{instanceId}/token/{token}/send-text","href":"/message/reply-message"},{"title":"Enviar enquete","api":"POST /instances/{instanceId}/token/{token}/send-poll","href":"/message/send-poll"},{"title":"Enviar voto para enquete","api":"POST /instances/{instanceId}/token/{token}/send-poll-vote","href":"/message/send-poll-vote"},{"title":"Enviar pedido","api":"POST /instances/{instanceId}/token/{token}/send-order","href":"/message/send-message-order"},{"title":"Atualizar status do pedido","api":"POST /instances/{instanceId}/token/{token}/order-status-update","href":"/message/send-order-status-update"},{"title":"Atualizar pagamento do pedido","api":"POST /instances/{instanceId}/token/{token}/order-payment-update","href":"/message/send-order-payment-update"},{"title":"Fixar / Desafixar mensagens","api":"POST /instances/{instanceId}/token/{token}/pin-message","href":"/message/send-pin-message"},{"title":"Enviar convite de admin do canal","api":"POST /instances/{instanceId}/token/{token}/send-newsletter-admin-invite","href":"/message/send-newsletter-admin-invite"},{"title":"Enviar evento","api":"POST /instances/{instanceId}/token/{token}/send-event","href":"/message/send-event"},{"title":"Editar evento","api":"POST /instances/{instanceId}/token/{token}/send-edit-event","href":"/message/send-edit-event"},{"title":"Responder evento","api":"POST /instances/{instanceId}/token/{token}/send-event-response","href":"/message/send-event-response"},{"title":"Responder texto com botões","api":"POST /instances/{instanceId}/token/{token}/reply-button","href":"/message/reply-button"},{"title":"Responder botão de ação","api":"POST /instances/{instanceId}/token/{token}/reply-template-button","href":"/message/reply-template-button"},{"title":"Responder lista de opções","api":"POST /instances/{instanceId}/token/{token}/reply-option-list","description":"Responde uma opção de lista de opções como se o usuário tivesse tocado nela","href":"/message/reply-option-list"}]},{"group":"Privacy","pages":[{"title":"Introdução","href":"/privacy/introduction"},{"title":"Listar contatos não permitidos","api":"GET /instances/{instanceId}/token/{token}/privacy/disallowed-contacts","description":"Lista os contatos na blacklist para certas interações com sua conta","href":"/privacy/get-disallowed-contacts"},{"title":"Visto por último","api":"POST /instances/{instanceId}/token/{token}/privacy/last-seen","href":"/privacy/set-last-seen"},{"title":"Foto do perfil","api":"POST /instances/{instanceId}/token/{token}/privacy/photo-visualization","href":"/privacy/set-photo-visualization"},{"title":"Recado do perfil","api":"POST /instances/{instanceId}/token/{token}/privacy/description","href":"/privacy/set-privacy-description"},{"title":"Permissão de adição em grupos","api":"POST /instances/{instanceId}/token/{token}/privacy/group-add","href":"/privacy/set-group-add-permission"},{"title":"Visibilidade online","api":"POST /instances/{instanceId}/token/{token}/privacy/online","href":"/privacy/set-privacy-online"},{"title":"Confirmação de leitura","api":"POST /instances/{instanceId}/token/{token}/privacy/read-receipts","href":"/privacy/set-read-receipts"},{"title":"Mensagens temporárias","api":"POST /instances/{instanceId}/token/{token}/privacy/messages-duration","href":"/privacy/set-messages-duration"}]},{"group":"Contacts","pages":[{"title":"Introdução","href":"/contacts/introduction"},{"title":"Pegar contatos","api":"GET /instances/{instanceId}/token/{token}/contacts","href":"/contacts/get-contacts"},{"title":"Adicionar contatos","api":"POST /instances/{instanceId}/token/{token}/contacts/add","href":"/contacts/add-contacts"},{"title":"Remover contatos","api":"DELETE /instances/{instanceId}/token/{token}/contacts/remove","href":"/contacts/remove-contacts"},{"title":"Metadata do contato","api":"GET /instances/{instanceId}/token/{token}/contacts/{phone}","href":"/contacts/get-metadata-contact"},{"title":"Pegar imagem do contato","api":"GET /instances/{instanceId}/token/{token}/profile-picture","href":"/contacts/get-profile-picture"},{"title":"Número com conta no aplicativo?","api":"GET /instances/{instanceId}/token/{token}/phone-exists/{phone}","href":"/contacts/get-iswhatsapp"},{"title":"Verificação em lote","api":"POST /instances/{instanceId}/token/{token}/phone-exists-batch","href":"/contacts/get-iswhatsapp-batch"},{"title":"Bloquear / Desbloquear contato","api":"POST /instances/{instanceId}/token/{token}/contacts/modify-blocked","href":"/contacts/block-contact"},{"title":"Denunciar contato","api":"POST /instances/{instanceId}/token/{token}/contacts/{phone}/report","href":"/contacts/report-contact"}]},{"group":"Chats","pages":[{"title":"Introdução","href":"/chats/introduction"},{"title":"Pegar chats","api":"GET /instances/{instanceId}/token/{token}/chats","href":"/chats/get-chats"},{"title":"Pegar metadata do chat","api":"GET /instances/{instanceId}/token/{token}/chats/{phone}","href":"/chats/get-metadata-chat"},{"title":"Ler chats","api":"POST /instances/{instanceId}/token/{token}/modify-chat","href":"/chats/read-chat"},{"title":"Arquivar chats","api":"POST /instances/{instanceId}/token/{token}/modify-chat","href":"/chats/archive-chat"},{"title":"Fixar chats","api":"POST /instances/{instanceId}/token/{token}/modify-chat","href":"/chats/pin-chat"},{"title":"Mutar chats","api":"POST /instances/{instanceId}/token/{token}/modify-chat","href":"/chats/mute-chat"},{"title":"Limpar chat","api":"POST /instances/{instanceId}/token/{token}/modify-chat","href":"/chats/clear-chat"},{"title":"Deletar chats","api":"POST /instances/{instanceId}/token/{token}/modify-chat","href":"/chats/delete-chat"},{"title":"Expiração do chat","api":"POST /instances/{instanceId}/token/{token}/send-chat-expiration","href":"/chats/send-chat-expiration"}]},{"group":"Calls","pages":[{"title":"Introdução","href":"/calls/introduction"},{"title":"Fazer ligação","api":"POST /instances/{instanceId}/token/{token}/send-call","href":"/calls/send-call"},{"title":"Gerar token para chamadas","api":"GET /instances/{instanceId}/token/{token}/call-token","href":"/calls/call-token"},{"title":"Gerar token SIP","api":"POST /instances/{instanceId}/token/{token}/sip-token","href":"/calls/sip-token"},{"title":"Obter informações SIP","api":"GET /instances/{instanceId}/token/{token}/sip-info","href":"/calls/sip-info"}]},{"group":"Groups","pages":[{"title":"Introdução","href":"/group/introduction"},{"title":"Buscar grupos","api":"GET /instances/{instanceId}/token/{token}/groups","href":"/group/get-groups"},{"title":"Criando grupos","api":"POST /instances/{instanceId}/token/{token}/create-group","href":"/group/create-group"},{"title":"Atualizar nome do grupo","api":"POST /instances/{instanceId}/token/{token}/update-group-name","href":"/group/update-group-name"},{"title":"Atualizar imagem do grupo","api":"POST /instances/{instanceId}/token/{token}/update-group-photo","href":"/group/update-group-photo"},{"title":"Adicionar participantes","api":"POST /instances/{instanceId}/token/{token}/add-participant","href":"/group/add-participant"},{"title":"Remover participantes","api":"POST /instances/{instanceId}/token/{token}/remove-participant","href":"/group/remove-participant"},{"title":"Aprovar participantes","api":"POST /instances/{instanceId}/token/{token}/approve-participant","href":"/group/approve-participant"},{"title":"Rejeitar participantes","api":"POST /instances/{instanceId}/token/{token}/reject-participant","href":"/group/reject-participant"},{"title":"Mencionar membro","api":"POST /instances/{instanceId}/token/{token}/send-text","href":"/group/mention-participant"},{"title":"Mencionar grupo","api":"POST /instances/{instanceId}/token/{token}/send-text","href":"/group/mention-group"},{"title":"Mencionar todos","api":"POST /instances/{instanceId}/token/{token}/send-text","href":"/group/mention-all"},{"title":"Promover admin do grupo","api":"POST /instances/{instanceId}/token/{token}/add-admin","href":"/group/add-admin"},{"title":"Remover admin do grupo","api":"POST /instances/{instanceId}/token/{token}/remove-admin","href":"/group/remove-admin"},{"title":"Sair do grupo","api":"POST /instances/{instanceId}/token/{token}/leave-group","href":"/group/leave-group"},{"title":"Metadata do grupo","api":"GET /instances/{instanceId}/token/{token}/group-metadata/{phone}","href":"/group/metadata-group"},{"title":"Metadata do grupo (leve)","api":"GET /instances/{instanceId}/token/{token}/light-group-metadata/{phone}","href":"/group/light-group-metadata"},{"title":"Metadata do grupo por convite","api":"GET /instances/{instanceId}/token/{token}/group-invitation-metadata","href":"/group/group-invitation-metadata"},{"title":"Configurações do grupo","api":"POST /instances/{instanceId}/token/{token}/update-group-settings","href":"/group/update-group-settings"},{"title":"Alterar descrição","api":"POST /instances/{instanceId}/token/{token}/update-group-description","href":"/group/update-group-description"},{"title":"Redefinir link de convite","api":"POST /instances/{instanceId}/token/{token}/redefine-invitation-link/{groupId}","href":"/group/redefine-invitation-link"},{"title":"Obter link de convite","api":"GET /instances/{instanceId}/token/{token}/group-invitation-link/{groupId}","href":"/group/get-invitation-link"},{"title":"Aceitar convite do grupo","api":"GET /instances/{instanceId}/token/{token}/accept-invite-group","href":"/group/accept-group-invite"}]},{"group":"Communities","pages":[{"title":"Introdução","href":"/communities/introduction"},{"title":"Criar comunidade","api":"POST /instances/{instanceId}/token/{token}/communities","href":"/communities/create-community"},{"title":"Listar comunidades","api":"GET /instances/{instanceId}/token/{token}/communities","href":"/communities/list-communities"},{"title":"Vincular grupos","api":"POST /instances/{instanceId}/token/{token}/communities/link","href":"/communities/link-groups"},{"title":"Desvincular grupos","api":"POST /instances/{instanceId}/token/{token}/communities/unlink","href":"/communities/unlink-groups"},{"title":"Metadata da comunidade","api":"GET /instances/{instanceId}/token/{token}/communities-metadata/{communityId}","href":"/communities/community-metadata"},{"title":"Redefinir link de convite","api":"POST /instances/{instanceId}/token/{token}/redefine-invitation-link/{communityId}","href":"/communities/redefine-invitation-link"},{"title":"Adicionar participantes","api":"POST /instances/{instanceId}/token/{token}/add-participant","href":"/communities/add-community-participant"},{"title":"Remover participantes","api":"POST /instances/{instanceId}/token/{token}/remove-participant","href":"/communities/remove-community-participant"},{"title":"Promover admin da comunidade","api":"POST /instances/{instanceId}/token/{token}/add-admin","href":"/communities/add-community-admin"},{"title":"Remover admin da comunidade","api":"POST /instances/{instanceId}/token/{token}/remove-admin","href":"/communities/remove-community-admin"},{"title":"Configurações da comunidade","api":"POST /instances/{instanceId}/token/{token}/communities/settings","href":"/communities/community-settings"},{"title":"Desativar comunidade","api":"DELETE /instances/{instanceId}/token/{token}/communities/{communityId}","href":"/communities/deactivate-community"},{"title":"Alterar descrição da comunidade","api":"POST /instances/{instanceId}/token/{token}/update-community-description","href":"/communities/update-community-description"}]},{"group":"Meta AI","pages":[{"title":"Introdução","href":"/metaai/introduction"},{"title":"Conversar com a Meta AI","api":"POST /instances/{instanceId}/token/{token}/send-text","href":"/metaai/conversation"}]},{"group":"Newsletter","pages":[{"title":"Introdução","href":"/newsletter/introduction"},{"title":"Criando canais","api":"POST /instances/{instanceId}/token/{token}/create-newsletter","href":"/newsletter/create-newsletter"},{"title":"Atualizar imagem do canal","api":"POST /instances/{instanceId}/token/{token}/update-newsletter-picture","href":"/newsletter/update-newsletter-picture"},{"title":"Atualizar nome do canal","api":"POST /instances/{instanceId}/token/{token}/update-newsletter-name","href":"/newsletter/update-newsletter-name"},{"title":"Atualizar descrição do canal","api":"POST /instances/{instanceId}/token/{token}/update-newsletter-description","href":"/newsletter/update-newsletter-description"},{"title":"Seguir canal","api":"PUT /instances/{instanceId}/token/{token}/follow-newsletter","href":"/newsletter/follow-newsletter"},{"title":"Deixar de seguir canal","api":"PUT /instances/{instanceId}/token/{token}/unfollow-newsletter","href":"/newsletter/unfollow-newsletter"},{"title":"Mutar canal","api":"PUT /instances/{instanceId}/token/{token}/mute-newsletter","href":"/newsletter/mute-newsletter"},{"title":"Desmutar canal","api":"PUT /instances/{instanceId}/token/{token}/unmute-newsletter","href":"/newsletter/unmute-newsletter"},{"title":"Deletar canal","api":"DELETE /instances/{instanceId}/token/{token}/delete-newsletter","href":"/newsletter/delete-newsletter"},{"title":"Metadata do canal","api":"GET /instances/{instanceId}/token/{token}/newsletter/metadata/{newsletterId}","href":"/newsletter/newsletter-metadata"},{"title":"Listar seguidores do canal","api":"GET /instances/{instanceId}/token/{token}/newsletter/subscribers/{newsletterId}","href":"/newsletter/newsletter-subscribers"},{"title":"Listar canais","api":"GET /instances/{instanceId}/token/{token}/newsletter","href":"/newsletter/newsletter-list"},{"title":"Encontrar canais","api":"POST /instances/{instanceId}/token/{token}/search-newsletter","href":"/newsletter/search-newsletter"},{"title":"Configurações do canal","api":"POST /instances/{instanceId}/token/{token}/newsletter/settings/{newsletterId}","href":"/newsletter/update-newsletter-config"},{"title":"Aceitar convite de admin","api":"POST /instances/{instanceId}/token/{token}/newsletter/accept-admin-invite/{newsletterId}","href":"/newsletter/accept-newsletter-admin-invite"},{"title":"Remover admin do canal","api":"POST /instances/{instanceId}/token/{token}/newsletter/remove-admin/{newsletterId}","href":"/newsletter/newsletter-remove-admin"},{"title":"Anular convite de admin","api":"POST /instances/{instanceId}/token/{token}/newsletter/revoke-admin-invite/{newsletterId}","href":"/newsletter/newsletter-revoke-admin-invite"},{"title":"Transferir propriedade do canal","api":"POST /instances/{instanceId}/token/{token}/newsletter/transfer-ownership/{newsletterId}","href":"/newsletter/transfer-newsletter-ownership"}]},{"group":"Transmission List","pages":[{"title":"Introdução","href":"/broadcast/introduction"},{"title":"Criar lista de transmissão","api":"POST /instances/{instanceId}/token/{token}/broadcast","href":"/broadcast/create-broadcast"},{"title":"Editar lista de transmissão","api":"PUT /instances/{instanceId}/token/{token}/broadcast/{broadcastId}","href":"/broadcast/update-broadcast"},{"title":"Listar listas de transmissão","api":"GET /instances/{instanceId}/token/{token}/broadcast","href":"/broadcast/list-broadcast"},{"title":"Deletar lista de transmissão","api":"DELETE /instances/{instanceId}/token/{token}/broadcast/{broadcastId}","href":"/broadcast/delete-broadcast"}]},{"group":"Status","pages":[{"title":"Introdução","href":"/status/introduction"},{"title":"Enviar texto status","api":"POST /instances/{instanceId}/token/{token}/send-text-status","href":"/status/send-text-status"},{"title":"Enviar imagem status","api":"POST /instances/{instanceId}/token/{token}/send-image-status","href":"/status/send-image-status"},{"title":"Enviar vídeo status","api":"POST /instances/{instanceId}/token/{token}/send-video-status","href":"/status/send-video-status"},{"title":"Responder status com texto","api":"POST /instances/{instanceId}/token/{token}/reply-status-text","href":"/status/reply-status-text"},{"title":"Responder status com GIF","api":"POST /instances/{instanceId}/token/{token}/reply-status-gif","href":"/status/reply-status-gif"},{"title":"Responder status com sticker","api":"POST /instances/{instanceId}/token/{token}/reply-status-sticker","href":"/status/reply-status-sticker"}]},{"group":"Message Queue","pages":[{"title":"Introdução","href":"/queue/introduction"},{"title":"Fila (Depreciada)","api":"GET /instances/{instanceId}/token/{token}/queue","href":"/queue/get-queue"},{"title":"Fila","api":"POST /instances/{instanceId}/token/{token}/queue","href":"/queue/post-queue"},{"title":"Apagar fila","api":"DELETE /instances/{instanceId}/token/{token}/queue","href":"/queue/delete-queue"},{"title":"Apagar mensagem da fila","api":"DELETE /instances/{instanceId}/token/{token}/queue/{zaapId}","href":"/queue/delete-queue-id"},{"title":"Atualizar configuração da fila","api":"PUT /instances/{instanceId}/token/{token}/update-queue-settings","href":"/queue/update-queue-settings"}]},{"group":"Aplicativo Business","pages":[{"title":"Introdução","href":"/business/introduction"},{"title":"Criar/editar produto","api":"POST /instances/{instanceId}/token/{token}/products","href":"/business/edit-product"},{"title":"Pegar produtos","api":"GET /instances/{instanceId}/token/{token}/catalogs","href":"/business/get-products"},{"title":"Pegar produtos (telefone)","api":"GET /instances/{instanceId}/token/{token}/catalogs/{phone}","href":"/business/get-products-phone"},{"title":"Pegar produtos V2","api":"POST /instances/{instanceId}/token/{token}/catalogs","href":"/business/get-products-v2"},{"title":"Pegar produtos V2 (telefone)","api":"POST /instances/{instanceId}/token/{token}/catalogs/{phone}","href":"/business/get-products-phone-v2"},{"title":"Pegar produto (ID)","api":"GET /instances/{instanceId}/token/{token}/products/{productId}","href":"/business/get-product-id"},{"title":"Deletar produto","api":"DELETE /instances/{instanceId}/token/{token}/products/{productId}","href":"/business/delete-product"},{"title":"Buscar etiquetas","api":"GET /instances/{instanceId}/token/{token}/tags","href":"/business/tags"},{"title":"Cores de etiquetas","api":"GET /instances/{instanceId}/token/{token}/business/tags/colors","href":"/business/tags-colors"},{"title":"Criar nova etiqueta","api":"POST /instances/{instanceId}/token/{token}/business/create-tag","href":"/business/create-tag"},{"title":"Editar etiqueta","api":"POST /instances/{instanceId}/token/{token}/business/edit-tag/{tagId}","href":"/business/edit-tag"},{"title":"Deletar etiqueta","api":"DELETE /instances/{instanceId}/token/{token}/business/tag/{tagId}","href":"/business/delete-tag"},{"title":"Atribuir etiquetas a um chat","api":"PUT /instances/{instanceId}/token/{token}/chats/{phone}/tags/{tag}/add","href":"/business/tags-add"},{"title":"Remover etiquetas de um chat","api":"PUT /instances/{instanceId}/token/{token}/chats/{phone}/tags/{tag}/remove","href":"/business/tags-remove"},{"title":"Atribuir anotações a um chat","api":"POST /instances/{instanceId}/token/{token}/chats/{phone}/notes","href":"/business/chats-notes"},{"title":"Configuração do catálogo","api":"POST /instances/{instanceId}/token/{token}/catalogs/config","href":"/business/save-catalog-config"},{"title":"Criar coleção","api":"POST /instances/{instanceId}/token/{token}/catalogs/collection","href":"/business/create-collection"},{"title":"Listar coleções","api":"GET /instances/{instanceId}/token/{token}/catalogs/collection","href":"/business/list-collections"},{"title":"Deletar coleção","api":"DELETE /instances/{instanceId}/token/{token}/catalogs/collection/{collectionId}","href":"/business/delete-collection"},{"title":"Editar coleção","api":"POST /instances/{instanceId}/token/{token}/catalogs/collection-edit/{collectionId}","href":"/business/edit-collection"},{"title":"Listar produtos de uma coleção","api":"GET /instances/{instanceId}/token/{token}/catalogs/collection-products/{phone}","href":"/business/list-collection-products"},{"title":"Adicionar produtos à coleção","api":"POST /instances/{instanceId}/token/{token}/catalogs/collection/add-product","href":"/business/add-product-to-collection"},{"title":"Remover produtos da coleção","api":"POST /instances/{instanceId}/token/{token}/catalogs/collection/remove-product","href":"/business/remove-product-from-collection"},{"title":"Alterar descrição da empresa","api":"POST /instances/{instanceId}/token/{token}/business/company-description","href":"/business/company-description"},{"title":"Alterar email da empresa","api":"POST /instances/{instanceId}/token/{token}/business/company-email","href":"/business/company-email"},{"title":"Alterar endereço da empresa","api":"POST /instances/{instanceId}/token/{token}/business/company-address","href":"/business/company-address"},{"title":"Alterar websites da empresa","api":"POST /instances/{instanceId}/token/{token}/business/company-websites","href":"/business/company-websites"},{"title":"Alterar horário de funcionamento","api":"POST /instances/{instanceId}/token/{token}/business/hours","href":"/business/business-hours"},{"title":"Listar categorias","api":"GET /instances/{instanceId}/token/{token}/business/available-categories","href":"/business/available-categories"},{"title":"Atribuir categorias","api":"POST /instances/{instanceId}/token/{token}/business/categories","href":"/business/company-categories"},{"title":"Dados da conta business","api":"GET /instances/{instanceId}/token/{token}/business/profile","href":"/business/profile"}]},{"group":"Webhooks","pages":[{"title":"Introdução","href":"/webhooks/introduction"},{"title":"Ao enviar","api":"PUT /instances/{instanceId}/token/{token}/update-webhook-delivery","href":"/webhooks/on-message-send"},{"title":"Exemplos de retorno de Ao enviar","href":"/webhooks/on-message-send-examples"},{"title":"Ao receber","api":"PUT /instances/{instanceId}/token/{token}/update-webhook-received","href":"/webhooks/on-message-received"},{"title":"Ao receber - enviadas por mim","api":"PUT /instances/{instanceId}/token/{token}/update-webhook-received-delivery","href":"/webhooks/on-message-received-and-delivery"},{"title":"Exemplos de retorno de Ao receber","href":"/webhooks/on-message-received-examples"},{"title":"Ao desconectar","api":"PUT /instances/{instanceId}/token/{token}/update-webhook-disconnected","href":"/webhooks/on-whatsapp-disconnected"},{"title":"Status da mensagem","api":"PUT /instances/{instanceId}/token/{token}/update-webhook-message-status","href":"/webhooks/on-whatsapp-message-status-changes"},{"title":"Status do chat","api":"PUT /instances/{instanceId}/token/{token}/update-webhook-chat-presence","href":"/webhooks/on-chat-presence"},{"title":"Exemplos de retorno de Status do chat","href":"/webhooks/on-chat-presence-examples"},{"title":"Ao conectar","api":"PUT /instances/{instanceId}/token/{token}/update-webhook-connected","href":"/webhooks/on-webhook-connected"},{"title":"Atualizar todos webhooks","api":"PUT /instances/{instanceId}/token/{token}/update-every-webhooks","href":"/webhooks/update-every-webhooks"},{"title":"Atualizar notificar enviadas por mim","api":"PUT /instances/{instanceId}/token/{token}/update-notify-sent-by-me","href":"/webhooks/update-notify-sent-by-me"},{"title":"Filtros de webhook","api":"PUT /instances/{instanceId}/token/{token}/update-filters","href":"/webhooks/update-filters"}]},{"group":"Partners","pages":[{"title":"Introdução","href":"/partner/introduction"},{"title":"Criando uma instância","api":"POST /instances/integrator/on-demand","href":"/partner/create-instance"},{"title":"Assinando uma instância","api":"POST /instances/{instanceId}/token/{token}/integrator/on-demand/subscription","href":"/partner/sign-instance"},{"title":"Cancelando uma instância","api":"POST /instances/{instanceId}/token/{token}/integrator/on-demand/cancel","href":"/partner/unsubscribe-instance"},{"title":"Deletando uma instância","api":"DELETE /instances/{instanceId}/token/{token}/integrator/on-demand/delete","href":"/partner/delete-instance"},{"title":"Deletando instâncias em lote","api":"POST /instances/integrator/on-demand/batch-delete","href":"/partner/delete-instances"},{"title":"Listando instâncias","api":"GET /instances","href":"/partner/list-instances"},{"title":"Atualizando a assinatura","api":"PUT /instances/{instanceId}/token/{token}/integrator/on-demand/subscription/update","href":"/partner/update-instance"},{"title":"Configurar proxy","api":"PUT /instances/{instanceId}/token/{token}/integrator/configure-proxy","href":"/partner/configure-proxy"},{"title":"Webhook de falha no proxy","api":"PUT /instances/{instanceId}/token/{token}/update-proxy-webhook","href":"/partner/update-proxy-webhook"},{"title":"Conexão via extensão para parceiros","href":"/partner/extension-token"},{"title":"Gerar token do SDK","api":"GET /instances/{instanceId}/token/{token}/sdk-connector-token","href":"/partner/sdk-connector-token"}]},{"group":"Integrators","pages":[{"title":"Find My Pack","href":"/integrators/introduction"}]}]}]}]},{"language":"en","navbar":{"links":[{"href":"https://api.whatsapp.com/send?phone=554431421722\u0026text=Hello,%20I%20would%20like%20to%20talk%20to%20Z-API%20support","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.z-api.io/"}},"pages":[{"title":"en","href":"/en/privacy/introduction"}]}]},"basePath":"","title":"Introdução - Z-API Docs","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":[],"chunks":[]}