Lista de filtros de tipo de mensagem. Os tipos incluídos no array não serão entregues no webhook de Ao receber (ReceivedCallback).
Veja os valores possíveis abaixo.
Lista de filtros de tipo de webhook. Os webhooks incluídos no array não serão disparados, mesmo que possuam uma URL configurada.
Veja os valores possíveis abaixo.
Aplicam-se aos webhooks em geral. Webhooks cujo tipo estiver no array callbackTypeFiltersnão serão disparados, independentemente de terem uma URL configurada.
FILTER_RECEIVED_CALLBACK
Desativa o disparo do webhook Ao receber (ReceivedCallback)
FILTER_DELIVERY_CALLBACK
Desativa o disparo do webhook Ao enviar (DeliveryCallback)
FILTER_CONNECTED_CALLBACK
Desativa o disparo do webhook Ao conectar (ConnectedCallback)
FILTER_DISCONNECTED_CALLBACK
Desativa o disparo do webhook Ao desconectar (DisconnectedCallback)
FILTER_PRESENCE_CHAT_CALLBACK
Desativa o disparo do webhook Status do chat (PresenceChatCallback)
FILTER_MESSAGE_STATUS_CALLBACK
Desativa o disparo do webhook Status da mensagem (MessageStatusCallback)
Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o PUT conforme especificado no início deste tópico.
Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.
{"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":""},"chroma":{"liveDeploymentHistoryId":"6aea4890ca1163ccfe95edea","collectionId":"518edace-7d8a-4d8b-8cb7-e7faf285e86f","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aea4890ca1163ccfe95edea"},"entitlements":{},"buildId":"6aea4890ca1163ccfe95edea","clientVersion":"0.0.4067","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":"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":"vite-origin","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":"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"webhooks/update-filters","slug":"/webhooks/update-filters","pageMetadata":{"title":"Filtros de webhook","api":"PUT /instances/{instanceId}/token/{token}/update-filters","description":"Configure quais tipos de mensagem e webhooks você deseja receber","href":"/webhooks/update-filters"},"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: \"Configure quais tipos de mensagem e webhooks você deseja receber\"\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`,code:`code`,hr:`hr`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Accordion,AccordionGroup,CodeBlock,Heading,Info,ParamField,Warning}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!AccordionGroup)_missingMdxReference(`AccordionGroup`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`conceituação`,children:`Conceituação`}),`\n`,_jsx(_components.p,{children:`O endpoint de filtros permite configurar quais eventos e tipos de mensagem serão disparados pelos webhooks da sua instância. É possível:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Filtrar `,_jsx(_components.strong,{children:`tipos de mensagem`}),` recebidas no webhook de `,_jsx(_components.a,{href:`/webhooks/on-message-received`,children:`Ao receber`}),` (ex: ignorar mensagens de grupos ou apenas de áudio)`]}),`\n`,_jsxs(_components.li,{children:[`Filtrar `,_jsx(_components.strong,{children:`tipos de webhook`}),` que serão disparados (ex: desativar o webhook de `,_jsx(_components.a,{href:`/webhooks/on-chat-presence`,children:`Status do chat`}),` sem remover a URL configurada)`]}),`\n`]}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[`As mesmas configurações também podem ser feitas diretamente pelo `,_jsx(_components.strong,{children:`painel da instância`}),`, através de botões em cada webhook.`]})}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Os filtros de `,_jsx(_components.code,{children:`messageFilters`}),` se aplicam `,_jsx(_components.strong,{children:`apenas`}),` ao webhook de `,_jsx(_components.a,{href:`/webhooks/on-message-received`,children:`Ao receber`}),`. Os demais webhooks não são afetados por esse filtro.`]})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`atualizar-filtros`,children:`Atualizar filtros`}),`\n`,_jsx(Heading,{level:`3`,id:`header`,children:`Header`}),`\n`,_jsx(ParamField,{path:`instanceId`,type:`string`,required:true,id:`param-instance-id`,children:_jsxs(_components.p,{children:[`ID da sua instância. Disponível no painel Z-API em `,_jsx(_components.strong,{children:`Instâncias`}),`.`]})}),`\n`,_jsx(ParamField,{path:`token`,type:`string`,required:true,id:`param-token`,children:_jsx(_components.p,{children:`Token da sua instância Z-API.`})}),`\n`,_jsx(Heading,{level:`3`,id:`body`,children:`Body`}),`\n`,_jsx(ParamField,{body:`messageFilters`,type:`array of strings`,id:`param-message-filters`,children:_jsxs(_components.p,{children:[`Lista de filtros de tipo de mensagem. Os tipos incluídos no array `,_jsx(_components.strong,{children:`não serão entregues`}),` no webhook de `,_jsx(_components.a,{href:`/webhooks/on-message-received`,children:`Ao receber`}),` (ReceivedCallback).\nVeja os `,_jsx(_components.a,{href:`#filtros-por-tipo-de-mensagem`,children:`valores possíveis`}),` abaixo.`]})}),`\n`,_jsx(ParamField,{body:`callbackTypeFilters`,type:`array of strings`,id:`param-callback-type-filters`,children:_jsxs(_components.p,{children:[`Lista de filtros de tipo de webhook. Os webhooks incluídos no array `,_jsx(_components.strong,{children:`não serão disparados`}),`, mesmo que possuam uma URL configurada.\nVeja os `,_jsx(_components.a,{href:`#filtros-por-tipo-de-webhook`,children:`valores possíveis`}),` abaixo.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`request-body`,children:`Request Body`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`19`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light poimandres`,style:{backgroundColor:`#fff`,\"--shiki-dark-bg\":`#1b1e28`,color:`#24292e`,\"--shiki-dark\":`#a6accd`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`19`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#A6ACCD`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#A6ACCD`},children:` \"`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#E4F0FB`},children:`messageFilters`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#A6ACCD`},children:`\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#A6ACCD`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#A6ACCD`},children:` \"`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#5DE4C7`},children:`FILTER_FROM_GROUP`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#A6ACCD`},children:`\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#A6ACCD`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#A6ACCD`},children:` \"`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#5DE4C7`},children:`FILTER_FROM_PRIVATE_CHAT`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#A6ACCD`},children:`\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#A6ACCD`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#A6ACCD`},children:` \"`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#5DE4C7`},children:`FILTER_TEXT_MESSAGE`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#A6ACCD`},children:`\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#A6ACCD`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#A6ACCD`},children:` \"`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#5DE4C7`},children:`FILTER_IMAGE_MESSAGE`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#A6ACCD`},children:`\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#A6ACCD`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#A6ACCD`},children:` \"`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#5DE4C7`},children:`FILTER_VIDEO_MESSAGE`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#A6ACCD`},children:`\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#A6ACCD`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#A6ACCD`},children:` \"`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#5DE4C7`},children:`FILTER_AUDIO_MESSAGE`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#A6ACCD`},children:`\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#A6ACCD`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#A6ACCD`},children:` \"`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#5DE4C7`},children:`FILTER_DOCUMENT_MESSAGE`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#A6ACCD`},children:`\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#A6ACCD`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#A6ACCD`},children:` \"`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#E4F0FB`},children:`callbackTypeFilters`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#A6ACCD`},children:`\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#A6ACCD`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#A6ACCD`},children:` \"`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#5DE4C7`},children:`FILTER_DELIVERY_CALLBACK`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#A6ACCD`},children:`\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#A6ACCD`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#A6ACCD`},children:` \"`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#5DE4C7`},children:`FILTER_DISCONNECTED_CALLBACK`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#A6ACCD`},children:`\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#A6ACCD`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#A6ACCD`},children:` \"`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#5DE4C7`},children:`FILTER_RECEIVED_CALLBACK`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#A6ACCD`},children:`\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#A6ACCD`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#A6ACCD`},children:` \"`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#5DE4C7`},children:`FILTER_PRESENCE_CHAT_CALLBACK`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#A6ACCD`},children:`\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#A6ACCD`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#A6ACCD`},children:` \"`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#5DE4C7`},children:`FILTER_MESSAGE_STATUS_CALLBACK`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#A6ACCD`},children:`\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#A6ACCD`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#A6ACCD`},children:` \"`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#5DE4C7`},children:`FILTER_CONNECTED_CALLBACK`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#A6ACCD`},children:`\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#A6ACCD`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#A6ACCD`},children:`}`})}),`\n`]})})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`tipos-de-filtro-para-webhooks`,children:`Tipos de filtro para webhooks`}),`\n`,_jsx(Heading,{level:`3`,id:`filtros-por-tipo-de-mensagem`,children:`Filtros por tipo de mensagem`}),`\n`,_jsxs(_components.p,{children:[`Aplicam-se ao webhook de `,_jsx(_components.a,{href:`/webhooks/on-message-received`,children:`Ao receber`}),` (ReceivedCallback). Mensagens cujo tipo estiver no array `,_jsx(_components.code,{children:`messageFilters`}),` `,_jsx(_components.strong,{children:`não serão entregues`}),`.`]}),`\n`,_jsxs(AccordionGroup,{children:[_jsx(Accordion,{title:`FILTER_FROM_GROUP`,id:`filter-from-group`,children:_jsxs(_components.p,{children:[`Filtra mensagens recebidas em `,_jsx(_components.strong,{children:`grupos`}),`. Quando ativo, nenhuma mensagem recebida em um grupo será entregue no `,_jsx(_components.code,{children:`ReceivedCallback`}),`.`]})}),_jsx(Accordion,{title:`FILTER_FROM_PRIVATE_CHAT`,id:`filter-from-private-chat`,children:_jsxs(_components.p,{children:[`Filtra mensagens recebidas em `,_jsx(_components.strong,{children:`conversas privadas`}),`. Quando ativo, apenas mensagens de recebidas de grupos serão entregues no `,_jsx(_components.code,{children:`ReceivedCallback`}),`.`]})}),_jsx(Accordion,{title:`FILTER_TEXT_MESSAGE`,id:`filter-text-message`,children:_jsxs(_components.p,{children:[`Filtra mensagens do tipo `,_jsx(_components.strong,{children:`texto simples`}),`.`]})}),_jsx(Accordion,{title:`FILTER_IMAGE_MESSAGE`,id:`filter-image-message`,children:_jsxs(_components.p,{children:[`Filtra mensagens do tipo `,_jsx(_components.strong,{children:`imagem`}),`.`]})}),_jsx(Accordion,{title:`FILTER_VIDEO_MESSAGE`,id:`filter-video-message`,children:_jsxs(_components.p,{children:[`Filtra mensagens do tipo `,_jsx(_components.strong,{children:`vídeo`}),`.`]})}),_jsx(Accordion,{title:`FILTER_AUDIO_MESSAGE`,id:`filter-audio-message`,children:_jsxs(_components.p,{children:[`Filtra mensagens do tipo `,_jsx(_components.strong,{children:`áudio`}),`.`]})}),_jsx(Accordion,{title:`FILTER_DOCUMENT_MESSAGE`,id:`filter-document-message`,children:_jsxs(_components.p,{children:[`Filtra mensagens do tipo `,_jsx(_components.strong,{children:`documento`}),`.`]})})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`3`,id:`filtros-por-tipo-de-webhook`,children:`Filtros por tipo de webhook`}),`\n`,_jsxs(_components.p,{children:[`Aplicam-se aos webhooks em geral. Webhooks cujo tipo estiver no array `,_jsx(_components.code,{children:`callbackTypeFilters`}),` `,_jsx(_components.strong,{children:`não serão disparados`}),`, independentemente de terem uma URL configurada.`]}),`\n`,_jsxs(AccordionGroup,{children:[_jsx(Accordion,{title:`FILTER_RECEIVED_CALLBACK`,id:`filter-received-callback`,children:_jsxs(_components.p,{children:[`Desativa o disparo do webhook `,_jsxs(_components.strong,{children:[_jsx(_components.a,{href:`/webhooks/on-message-received`,children:`Ao receber`}),` (ReceivedCallback)`]})]})}),_jsx(Accordion,{title:`FILTER_DELIVERY_CALLBACK`,id:`filter-delivery-callback`,children:_jsxs(_components.p,{children:[`Desativa o disparo do webhook `,_jsxs(_components.strong,{children:[_jsx(_components.a,{href:`/webhooks/on-message-send`,children:`Ao enviar`}),` (DeliveryCallback)`]})]})}),_jsx(Accordion,{title:`FILTER_CONNECTED_CALLBACK`,id:`filter-connected-callback`,children:_jsxs(_components.p,{children:[`Desativa o disparo do webhook `,_jsxs(_components.strong,{children:[_jsx(_components.a,{href:`/webhooks/on-webhook-connected`,children:`Ao conectar`}),` (ConnectedCallback)`]})]})}),_jsx(Accordion,{title:`FILTER_DISCONNECTED_CALLBACK`,id:`filter-disconnected-callback`,children:_jsxs(_components.p,{children:[`Desativa o disparo do webhook `,_jsxs(_components.strong,{children:[_jsx(_components.a,{href:`/webhooks/on-whatsapp-disconnected`,children:`Ao desconectar`}),` (DisconnectedCallback)`]})]})}),_jsx(Accordion,{title:`FILTER_PRESENCE_CHAT_CALLBACK`,id:`filter-presence-chat-callback`,children:_jsxs(_components.p,{children:[`Desativa o disparo do webhook `,_jsxs(_components.strong,{children:[_jsx(_components.a,{href:`/webhooks/on-chat-presence`,children:`Status do chat`}),` (PresenceChatCallback)`]})]})}),_jsx(Accordion,{title:`FILTER_MESSAGE_STATUS_CALLBACK`,id:`filter-message-status-callback`,children:_jsxs(_components.p,{children:[`Desativa o disparo do webhook `,_jsxs(_components.strong,{children:[_jsx(_components.a,{href:`/webhooks/on-whatsapp-message-status-changes`,children:`Status da mensagem`}),` (MessageStatusCallback)`]})]})})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(Heading,{level:`3`,id:`200`,children:`200`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light poimandres`,style:{backgroundColor:`#fff`,\"--shiki-dark-bg\":`#1b1e28`,color:`#24292e`,\"--shiki-dark\":`#a6accd`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#A6ACCD`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#A6ACCD`},children:` \"`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#E4F0FB`},children:`value`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#A6ACCD`},children:`\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#A6ACCD`},children:`: `}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#5DE4C7`},children:`true`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#A6ACCD`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`405`,children:`405`}),`\n`,_jsx(_components.p,{children:`Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o PUT conforme especificado no início deste tópico.`}),`\n`,_jsx(Heading,{level:`3`,id:`415`,children:`415`}),`\n`,_jsx(_components.p,{children:`Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.`})]})}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":"Filtros de webhook","api":"PUT /instances/{instanceId}/token/{token}/update-filters","description":"Configure quais tipos de mensagem e webhooks você deseja receber","href":"/webhooks/update-filters"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Conceituação","slug":"conceituação","depth":2,"children":[]},{"title":"Atualizar filtros","slug":"atualizar-filtros","depth":2,"children":[{"title":"Header","slug":"header","depth":3,"children":[]},{"title":"Body","slug":"body","depth":3,"children":[]},{"title":"Request Body","slug":"request-body","depth":3,"children":[]}]},{"title":"Tipos de filtro para webhooks","slug":"tipos-de-filtro-para-webhooks","depth":2,"children":[{"title":"Filtros por tipo de mensagem","slug":"filtros-por-tipo-de-mensagem","depth":3,"children":[]},{"title":"Filtros por tipo de webhook","slug":"filtros-por-tipo-de-webhook","depth":3,"children":[]}]},{"title":"Response","slug":"response","depth":2,"children":[{"title":"200","slug":"200","depth":3,"children":[]},{"title":"405","slug":"405","depth":3,"children":[]},{"title":"415","slug":"415","depth":3,"children":[]}]}],"codeExamples":{},"endpoint":{"title":"Filtros de webhook","path":"/instances/{instanceId}/token/{token}/update-filters","method":"put","request":{"security":[],"parameters":{"query":{},"header":{},"cookie":{},"path":{"instanceId":{"schema":[{"type":"string","description":"ID da sua instância. Disponível no painel Z-API em Instâncias .","required":true}]},"token":{"schema":[{"type":"string","description":"Token da sua instância Z-API.","required":true}]}}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"messageFilters":[{"type":"object","properties":{},"description":"Lista de filtros de tipo de mensagem. Os tipos incluídos no array não serão entregues no webhook de Ao receber (ReceivedCallback). Veja os valores possíveis abaixo."}],"callbackTypeFilters":[{"type":"object","properties":{},"description":"Lista de filtros de tipo de webhook. Os webhooks incluídos no array não serão disparados , mesmo que possuam uma URL configurada. Veja os valores possíveis abaixo."}]}}],"examples":{"example":{"value":{"messageFilters":{},"callbackTypeFilters":{}}}}}}},"response":{},"deprecated":false}},"jsLinks":["/_mintlify/custom/z-api-8aa3bb40/a56ff8c5f47a412e/gptmaker.js"],"subdomain":"z-api-8aa3bb40","siteName":"Z-API Docs","title":"Filtros de webhook - Z-API Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"pt-BR":{"href":"/webhooks/update-filters","matchLevel":0},"en":{"href":"/en/webhooks/update-filters","matchLevel":1}}},"lastModified":"2026-06-16T17:26:46.524Z","originalFileLocation":"webhooks/update-filters.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=\"Configure quais tipos de mensagem e webhooks você deseja receber\">\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=\"Filtros de webhook - Z-API Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Configure quais tipos de mensagem e webhooks você deseja receber\">\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/webhooks/update-filters\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://z-api-8aa3bb40.mintlify.app/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Filtros+de+webhook\u0026amp;description=Configure+quais+tipos+de+mensagem+e+webhooks+voc%C3%AA+deseja+receber\u0026amp;theme=1e9f2e2415957578442f4649\u0026amp;signature=ed4cb59f84b3f303d3fc191079f5d75708b992712239aa9da50d87dc099dae98\">\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=\"Filtros de webhook - Z-API Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Configure quais tipos de mensagem e webhooks você deseja receber\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://z-api-8aa3bb40.mintlify.app/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Filtros+de+webhook\u0026amp;description=Configure+quais+tipos+de+mensagem+e+webhooks+voc%C3%AA+deseja+receber\u0026amp;theme=1e9f2e2415957578442f4649\u0026amp;signature=ed4cb59f84b3f303d3fc191079f5d75708b992712239aa9da50d87dc099dae98\">\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/webhooks/update-filters\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/webhooks/update-filters.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt-BR\" href=\"https://developer.z-api.io/webhooks/update-filters\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://developer.z-api.io/en/webhooks/update-filters\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://developer.z-api.io/webhooks/update-filters\">\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/webhooks/update-filters#webpage\",\"url\":\"https://developer.z-api.io/webhooks/update-filters\",\"name\":\"Filtros de webhook\",\"description\":\"Configure quais tipos de mensagem e webhooks você deseja receber\",\"dateModified\":\"2026-06-16T17:26:46.524Z\",\"isPartOf\":{\"@id\":\"https://developer.z-api.io#website\"},\"breadcrumb\":{\"@id\":\"https://developer.z-api.io/webhooks/update-filters#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.z-api.io/webhooks/update-filters#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://developer.z-api.io/instance/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Webhooks\",\"item\":\"https://developer.z-api.io/webhooks/introduction\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Filtros de webhook\",\"item\":\"https://developer.z-api.io/webhooks/update-filters\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.z-api.io/webhooks/update-filters#apireference\",\"headline\":\"Filtros de webhook\",\"name\":\"Filtros de webhook\",\"description\":\"Configure quais tipos de mensagem e webhooks você deseja receber\",\"url\":\"https://developer.z-api.io/webhooks/update-filters\",\"mainEntityOfPage\":{\"@id\":\"https://developer.z-api.io/webhooks/update-filters#webpage\"},\"dateModified\":\"2026-06-16T17:26:46.524Z\",\"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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","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","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","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","description":"Habilita a opção de receber mensagens enviadas por você através do webhook","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","description":"Parceiro Integrador Z-API - Como funciona o programa de parceiros","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/webhooks/update-filters"}]}]},"basePath":"","title":"Filtros de webhook - Z-API Docs","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js"]}