Use este endpoint para atualizar os dados da própria instância na plataforma: o nome (name), os metadados (metadata) e o identificador de pesquisa (lookup_key).Ele não altera o perfil do WhatsApp (nome de exibição, foto, descrição). Para isso, use o endpoint de atualização de perfil. As configurações de comportamento têm o seu próprio endpoint de atualização de configurações.
Você não precisa enviar todos os campos a cada chamada. Envie apenas o que quer mudar e tudo o que ficar de fora continua exatamente como está.Nenhum campo aceita null: name é sempre um texto, e os valores de metadata são sempre um texto ou um número. Para “limpar” um valor, veja a regra da string vazia logo abaixo.
O metadata também é atualizado de forma parcial: as chaves enviadas são alteradas e todas as outras permanecem intactas. Não é necessário (nem recomendado) reenviar o objeto inteiro.
Para alterar ou criar uma chave, envie a chave com o novo valor.
Para manter uma chave como está, simplesmente não a envie.
Para limpar o valor de uma chave, envie uma string vazia "".
Por exemplo, se a instância tem os metadados customer_id, customer_name e campaign, a requisição abaixo altera customer_id, limpa campaign e mantém customer_name intacto:
Chaves de metadata iniciadas com wa_ são gerenciadas automaticamente pela plataforma e funcionam como somente leitura: se você enviá-las na requisição, elas são ignoradas e os valores originais são preservados. Use outros nomes para as suas próprias chaves.
Metadados armazenados como chave e valor. Cada chave é um texto e o valor pode ser um texto ou um número, nunca null.
A atualização é parcial: apenas as chaves enviadas são alteradas e as demais permanecem como estão. Para limpar o valor de uma chave, envie uma string vazia "".
Chaves iniciadas com wa_ são gerenciadas pela plataforma e somente leitura: se enviadas, são ignoradas.
Identificador único opcional de pesquisa que permite associar sua instância a uma estrutura de dados específica. A Zapster API não utiliza esse dado internamente; ele serve exclusivamente para facilitar consultas na API.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Zapster API","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/zapsterapi/hkJBRd8211Vh6izL/logo/light.svg?fit=max\u0026auto=format\u0026n=hkJBRd8211Vh6izL\u0026q=85\u0026s=7f89e972a4a31e307a18ba827099ba54","dark":"https://mintcdn.com/zapsterapi/hkJBRd8211Vh6izL/logo/dark.svg?fit=max\u0026auto=format\u0026n=hkJBRd8211Vh6izL\u0026q=85\u0026s=0584b46f3a6a9f5ef5186367a623ed31","href":"https://app.zapsterapi.com/?utm_source=Documentation\u0026utm_medium=Logo"},"favicon":"https://mintcdn.com/zapsterapi/hkJBRd8211Vh6izL/favicon.svg?fit=max\u0026auto=format\u0026n=hkJBRd8211Vh6izL\u0026q=85\u0026s=1d151a6daf40e21848a8e653dd56911e","api":{"openapi":{"source":"pt-BR/v1/openapi/openapi.json"},"playground":{"display":"interactive"}},"navbar":{"links":[{"href":"https://wa.me/5587999079455?text=Olá, preciso de ajuda com a documentação da Zapster","label":"Suporte"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.zapsterapi.com/?utm_source=Documentation\u0026utm_medium=NavbarButton"}},"integrations":{"gtm":{"tagId":"GTM-PF4DXJPP"}},"styling":{"latex":false},"navigation":{"languages":[{"language":"pt-BR","default":true,"href":"pt-BR/v1/introduction"},{"language":"en","href":"en/v1/introduction"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"zapsterapi","hasAudioNarration":false,"actualSubdomain":"zapsterapi","customDomains":["developer.zapsterapi.com"],"gitSource":{"type":"github","owner":"zapsterapi","repo":"zapsterapi-monorepo","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae129f0a0016dd52b435656","collectionId":"84f617dc-1a5c-4cd4-88d4-2529d3a8d2a2","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae129f0a0016dd52b435656"},"entitlements":{},"buildId":"6ae129f0a0016dd52b435656","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"pt-BR","tag":"Referência da API","count":41},{"language":"pt-BR","tag":"Visão Geral","count":28},{"language":"pt-BR","tag":"CLI","count":18},{"language":"pt-BR","tag":"Instâncias","count":17},{"language":"en","tag":"Overview","count":16},{"language":"pt-BR","tag":"Para Grupos","count":9},{"language":"en","tag":"Guides","count":8},{"language":"pt-BR","tag":"Guias","count":8},{"language":"en","tag":"Concepts","count":7},{"language":"pt-BR","tag":"Webhooks","count":7},{"language":"pt-BR","tag":"Conceitos","count":7},{"language":"en","tag":"CLI","count":6},{"language":"pt-BR","tag":"Utilidades","count":6},{"language":"pt-BR","tag":"Mensagens","count":5},{"language":"en","tag":"Introduction","count":1}]},"assistantConfig":{},"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":"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":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"pt-BR/v1/api-reference/instance/update-instance","slug":"/pt-BR/v1/api-reference/instance/update-instance","pageMetadata":{"title":"Atualizando a Instância","openapi":"PATCH /wa/instances/{instance_id}","description":"Atualiza os dados da instância na plataforma, como o nome e os metadados.\n","href":"/pt-BR/v1/api-reference/instance/update-instance"},"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: \"Atualiza os dados da instância na plataforma, como o nome e os metadados.\"\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`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Use este endpoint para atualizar os dados da própria instância na plataforma: o nome (`,_jsx(_components.code,{children:`name`}),`), os metadados (`,_jsx(_components.code,{children:`metadata`}),`) e o identificador de pesquisa (`,_jsx(_components.code,{children:`lookup_key`}),`).`]}),`\n`,_jsxs(_components.p,{children:[`Ele não altera o perfil do WhatsApp (nome de exibição, foto, descrição). Para isso, use o endpoint de `,_jsx(_components.a,{href:`/pt-BR/v1/api-reference/instance/update-profile`,children:`atualização de perfil`}),`. As configurações de comportamento têm o seu próprio endpoint de `,_jsx(_components.a,{href:`/pt-BR/v1/api-reference/instance/update-settings`,children:`atualização de configurações`}),`.`]}),`\n`,_jsx(Heading,{level:`3`,id:`atualize-só-o-que-precisar`,children:`Atualize só o que precisar`}),`\n`,_jsx(_components.p,{children:`Você não precisa enviar todos os campos a cada chamada. Envie apenas o que quer mudar e tudo o que ficar de fora continua exatamente como está.`}),`\n`,_jsxs(_components.p,{children:[`Nenhum campo aceita `,_jsx(_components.code,{children:`null`}),`: `,_jsx(_components.code,{children:`name`}),` é sempre um texto, e os valores de `,_jsx(_components.code,{children:`metadata`}),` são sempre um texto ou um número. Para “limpar” um valor, veja a regra da string vazia logo abaixo.`]}),`\n`,_jsxs(Heading,{level:`3`,id:`como-o-metadata-é-atualizado`,children:[`Como o `,_jsx(_components.code,{children:`metadata`}),` é atualizado`]}),`\n`,_jsxs(_components.p,{children:[`O `,_jsx(_components.code,{children:`metadata`}),` também é atualizado de forma parcial: as chaves enviadas são alteradas e todas as outras permanecem intactas. Não é necessário (nem recomendado) reenviar o objeto inteiro.`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Para `,_jsx(_components.strong,{children:`alterar ou criar`}),` uma chave, envie a chave com o novo valor.`]}),`\n`,_jsxs(_components.li,{children:[`Para `,_jsx(_components.strong,{children:`manter`}),` uma chave como está, simplesmente não a envie.`]}),`\n`,_jsxs(_components.li,{children:[`Para `,_jsx(_components.strong,{children:`limpar`}),` o valor de uma chave, envie uma string vazia `,_jsx(_components.code,{children:`\"\"`}),`.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Por exemplo, se a instância tem os metadados `,_jsx(_components.code,{children:`customer_id`}),`, `,_jsx(_components.code,{children:`customer_name`}),` e `,_jsx(_components.code,{children:`campaign`}),`, a requisição abaixo altera `,_jsx(_components.code,{children:`customer_id`}),`, limpa `,_jsx(_components.code,{children:`campaign`}),` e mantém `,_jsx(_components.code,{children:`customer_name`}),` intacto:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`6`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"metadata\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"customer_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"789012\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"campaign\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(Heading,{level:`3`,id:`chaves-reservadas-wa_`,children:[`Chaves reservadas `,_jsx(_components.code,{children:`wa_`})]}),`\n`,_jsxs(_components.p,{children:[`Chaves de metadata iniciadas com `,_jsx(_components.code,{children:`wa_`}),` são gerenciadas automaticamente pela plataforma e funcionam como somente leitura: se você enviá-las na requisição, elas são ignoradas e os valores originais são preservados. Use outros nomes para as suas próprias chaves.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Atualizando a Instância","openapi":"PATCH /wa/instances/{instance_id}","description":"Atualiza os dados da instância na plataforma, como o nome e os metadados.\n","href":"/pt-BR/v1/api-reference/instance/update-instance"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Atualize só o que precisar","slug":"atualize-só-o-que-precisar","depth":3,"children":[]},{"title":"Como o metadata é atualizado","slug":"como-o-metadata-é-atualizado","depth":3,"children":[]},{"title":"Chaves reservadas wa_","slug":"chaves-reservadas-wa_","depth":3,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/zapsterapi/d763f142efc774ff/watch-openapi.js"],"openApiReferenceData":{"operation":{"summary":"Atualização da Instância","deprecated":false,"description":"Atualiza os dados da instância na plataforma, como o nome e os metadados.\n","tags":[],"security":["fc55a784-da9f-4cf5-91e3-ec51b7408152"],"parameters":["cc5a0e35-c499-471b-aa70-d3f2e280fe75"],"requestBody":"e5b47a9e-68be-4f9c-a38a-ec231a4a1a6a","responses":{"200":"c7a33d98-0da8-4606-93ee-4c89592db029","400":"eed2780a-0002-4894-b615-4f344658a496","404":"81c056d4-10f6-4fa9-9bbc-156b745d3719"},"method":"patch","type":"path","servers":["47a9c70c-c4df-478d-b870-e68c65cdee2a"],"path":"/wa/instances/{instance_id}","baseUrlOptions":["https://api.zapsterapi.com/v1"],"title":"Atualização da Instância","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"cc5a0e35-c499-471b-aa70-d3f2e280fe75":{"name":"instance_id","in":"path","description":"ID da instância.","required":true,"example":"ozj35qv418rpmlrb","schema":{"type":"string","isRequired":true,"description":"ID da instância.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"Minha Instância","description":"Nome da instância na plataforma. Sempre um texto, nunca `null`.\n","uniqueKey":"name","typeLabel":"string"},"metadata":{"type":"object","description":"Metadados armazenados como chave e valor. Cada chave é um texto e o valor pode ser um texto ou um número, nunca `null`.\n\nA atualização é parcial: apenas as chaves enviadas são alteradas e as demais permanecem como estão. Para limpar o valor de uma chave, envie uma string vazia `\"\"`.\n\nChaves iniciadas com `wa_` são gerenciadas pela plataforma e somente leitura: se enviadas, são ignoradas.\n","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"metadata.additionalProperties.oneOf.1","typeLabel":"number"}],"uniqueKey":"metadata.additionalProperties","typeLabel":"string | number"},"uniqueKey":"metadata","typeLabel":"object"},"lookup_key":{"type":"string","maxLength":32,"example":"ins_8j7wlxmpjlixx9mux5","description":"Identificador único opcional de pesquisa que permite associar sua instância a uma estrutura de dados específica. A Zapster API não utiliza esse dado internamente; ele serve exclusivamente para facilitar consultas na API.\n","uniqueKey":"lookup_key","typeLabel":"string"}},"example":{"name":"Loja Centro","metadata":{"customer_id":"123456","campaign":""}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"Loja Centro","metadata":{"customer_id":"123456","campaign":""}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"c7a33d98-0da8-4606-93ee-4c89592db029":{"description":"Success","content":{"application/json":{"schema":{"type":"object","description":"Estrutura de uma instância registrada na API.","properties":{"created_at":{"type":"string","format":"date-time","description":"Data e hora de criação da instância no formato ISO 8601.","example":"2024-10-03T21:56:22.620Z","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"id":{"type":"string","description":"Identificador único da instância.","example":"xy9rexnkwobmgg3tehgvs","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"metadata":{"type":"object","description":"Metadados adicionais armazenados como chave e valor.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"metadata.additionalProperties.oneOf.1","typeLabel":"number"}],"uniqueKey":"metadata.additionalProperties","typeLabel":"string | number"},"example":{"customer_id":"123456","customer_name":"Joãozinho","phone_number":"+5587989075555"},"isRequired":true,"uniqueKey":"metadata","typeLabel":"object"},"name":{"type":"string","description":"Nome da instância.","example":"MyNewInstance2","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"owner":{"type":"object","description":"Informações sobre o proprietário da instância.","properties":{"id":{"type":"string","format":"uuid","description":"Identificador único do proprietário.","isRequired":true,"uniqueKey":"owner.id","typeLabel":"string\u003cuuid>"},"display_name":{"oneOf":[{"type":"string","description":"Nome de exibição do proprietário. Pode ser nulo.","example":null,"uniqueKey":"owner.display_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Nome de exibição do proprietário. Pode ser nulo.","example":null,"uniqueKey":"owner.display_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.display_name","typeLabel":"string | null"}},"required":["id"],"isRequired":true,"uniqueKey":"owner","typeLabel":"object"},"settings":{"type":"object","description":"Objeto **opcional** de configurações da sua instância.\n","properties":{"call_rejection":{"type":"string","description":"Define o comportarmento de rejeição de ligações.\n\n- `all` - Irá rejeitar todas ligações\n- `none` - Não irá rejeitar ligações.\n- `video_only` - Irá rejeitar apenas ligações de **vídeo**.\n- `audio_only` - Irá rejeitar apenas ligações de **audio**.\n","enum":["all","none","video_only","audio_only"],"uniqueKey":"settings.call_rejection","typeLabel":"enum\u003cstring>"},"delay_per_word":{"type":"boolean","description":"Define se o delay antes de enviar a mensagem deve ser baseado na quantidade de palavras.\n\nℹ️ Limitado a no máximo **10 segundos** de espera.\n","uniqueKey":"settings.delay_per_word","typeLabel":"boolean"},"delete_chat_after_sent":{"type":"boolean","description":"⚠️ *Esta função não está funcionando adequadamente, estamos trabalhando para regulariza-la.*\n\nDefine se o chat/conversa deve ser limpo depois do envio da mensagem. Isso garante que o dispositivo fique acumulando mensagens a ponto de muitas vezes travar o dispositivo que foi conectado.\n","uniqueKey":"settings.delete_chat_after_sent","typeLabel":"boolean"},"message_delay":{"type":"object","description":"Define a configuração de delay antes do envio da mensagem, se configurado `delay_per_word` é ignorado. O tempo é gerado randomicamente entre os limites configurado (`min` e `max`).\n","properties":{"enabled":{"type":"boolean","default":true,"uniqueKey":"settings.message_delay.enabled","typeLabel":"boolean"},"max":{"type":"integer","description":"Máximo de tempo em segundos que deve ser esperado antes do envio da mensagem.","default":10,"uniqueKey":"settings.message_delay.max","typeLabel":"integer"},"min":{"type":"integer","description":"Mínimo de tempo em segundos que deve ser esperado antes do envio da mensagem.","default":1,"uniqueKey":"settings.message_delay.min","typeLabel":"integer"}},"uniqueKey":"settings.message_delay","typeLabel":"object"},"presence_behavior":{"type":"string","description":"Define o comportamento da presença (Online, Digitando..., Gravando...) da sua instância.\n\n- `only_composing` - Exibe \"Digitando...\" durante o envio das mensagens, sem marcar a conta como \"Online\". (**recomendado**)\n- `always_online` - A conta aparece sempre \"Online\". Atenção: enquanto a conta está \"Online\" por um dispositivo vinculado, o WhatsApp pode deixar de enviar notificações para o celular onde o número está instalado.\n- `always_offline` - Nunca aparece \"Online\" e não exibe \"Digitando...\" durante os envios.\n","enum":["only_composing","always_online","always_offline"],"uniqueKey":"settings.presence_behavior","typeLabel":"enum\u003cstring>"},"read_confirmation":{"oneOf":[{"type":"string","description":"Define o comportamento de \"confirmação de leitura\", ou seja, a leitura automática das mensagens recebidas.\n\nAceita os valores clássicos em texto ou um objeto segmentado por tipo de conversa:\n\n- `never` - Nunca confirma a leitura (equivale a todos os segmentos desligados)\n- `always` - Sempre confirma a leitura (equivale a todos os segmentos ligados)\n- Objeto com os campos `chats`, `groups` e `status` - Controla cada segmento de forma independente\n\nNo formato de objeto, cada campo é booleano e o padrão é `false`:\n\n- `chats` - Conversas individuais\n- `groups` - Grupos\n- `status` - Status publicados pelos seus contatos (com este segmento ligado, os status recebidos são marcados como vistos)\n\nMensagens enviadas pela própria instância, listas de transmissão e publicações de canais nunca recebem confirmação de leitura automática.\n","enum":["never","always"],"uniqueKey":"settings.read_confirmation.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"object","description":"Define o comportamento de \"confirmação de leitura\", ou seja, a leitura automática das mensagens recebidas.\n\nAceita os valores clássicos em texto ou um objeto segmentado por tipo de conversa:\n\n- `never` - Nunca confirma a leitura (equivale a todos os segmentos desligados)\n- `always` - Sempre confirma a leitura (equivale a todos os segmentos ligados)\n- Objeto com os campos `chats`, `groups` e `status` - Controla cada segmento de forma independente\n\nNo formato de objeto, cada campo é booleano e o padrão é `false`:\n\n- `chats` - Conversas individuais\n- `groups` - Grupos\n- `status` - Status publicados pelos seus contatos (com este segmento ligado, os status recebidos são marcados como vistos)\n\nMensagens enviadas pela própria instância, listas de transmissão e publicações de canais nunca recebem confirmação de leitura automática.\n","properties":{"chats":{"type":"boolean","default":false,"description":"Confirma a leitura de mensagens recebidas em conversas individuais.","uniqueKey":"settings.read_confirmation.oneOf.1.chats","typeLabel":"boolean"},"groups":{"type":"boolean","default":false,"description":"Confirma a leitura de mensagens recebidas em grupos.","uniqueKey":"settings.read_confirmation.oneOf.1.groups","typeLabel":"boolean"},"status":{"type":"boolean","default":false,"description":"Marca como vistos os status publicados pelos seus contatos.","uniqueKey":"settings.read_confirmation.oneOf.1.status","typeLabel":"boolean"}},"uniqueKey":"settings.read_confirmation.oneOf.1","typeLabel":"object"}],"uniqueKey":"settings.read_confirmation","typeLabel":"enum\u003cstring> | object"}},"isRequired":true,"uniqueKey":"settings","typeLabel":"object"},"status":{"type":"string","enum":["connected","disconnected","offline"],"description":"Status atual da instância","example":"disconnected","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"webhooks":{"type":"array","description":"Lista de webhooks configurados para esta instância.","items":{"type":"object","description":"Configuração de um webhook associado à instância.","properties":{"enabled":{"type":"boolean","description":"Indica se o webhook está ativado.","example":true,"isRequired":true,"uniqueKey":"webhooks.items.[INDEX].enabled","typeLabel":"boolean"},"events":{"type":"array","description":"Lista de eventos que acionam este webhook.","items":{"type":"string","enum":["call.accepted","call.missed","call.received","call.rejected","group.created","group.participants_added","group.participants_demoted","group.participants_promoted","group.participants_removed","group.updated","instance.connected","instance.disconnected","instance.forbidden","instance.mentioned","instance.qrcode","instance.restricted","instance.restriction_lifted","message.deleted","message.delivered","message.edited","message.failed","message.flow_reply","message.pinned","message.reaction","message.read","message.received","message.sent","message.unpinned","poll.created","poll.deleted","poll.updated","status.reply"],"uniqueKey":"webhooks.items.[INDEX].events.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["message.received"],"isRequired":true,"uniqueKey":"webhooks.items.[INDEX].events","typeLabel":"enum\u003cstring>[]"},"id":{"type":"string","description":"Identificador único do webhook.","example":"2nenz69l0xbf0m3uu9tfo","isRequired":true,"uniqueKey":"webhooks.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Nome do webhook configurado.","example":"Webhook Name","isRequired":true,"uniqueKey":"webhooks.items.[INDEX].name","typeLabel":"string"},"test_mode":{"type":"boolean","description":"Indica se o webhook está em modo de teste.","example":false,"isRequired":true,"uniqueKey":"webhooks.items.[INDEX].test_mode","typeLabel":"boolean"},"url":{"type":"string","format":"uri","description":"URL do webhook para onde os eventos serão enviados.","example":"https://webhook.mydomain.com","isRequired":true,"uniqueKey":"webhooks.items.[INDEX].url","typeLabel":"string\u003curi>"},"test_url":{"oneOf":[{"type":"string","description":"URL de teste do webhook, se disponível.","example":null,"uniqueKey":"webhooks.items.[INDEX].test_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL de teste do webhook, se disponível.","example":null,"uniqueKey":"webhooks.items.[INDEX].test_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhooks.items.[INDEX].test_url","typeLabel":"string | null"}},"required":["enabled","events","id","name","test_mode","url"],"uniqueKey":"webhooks.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"webhooks","typeLabel":"object[]"},"connection_type":{"type":"string","enum":["unofficial","waba"],"description":"Tipo de conexão da instância:\n- `unofficial`: conexão via QR code (padrão)\n- `waba`: conexão via API oficial do WhatsApp (Cloud API da Meta)\n","example":"unofficial","uniqueKey":"connection_type","typeLabel":"enum\u003cstring>"},"qrcode":{"oneOf":[{"type":"string","description":"QR Code da instância, caso disponível.","example":null,"uniqueKey":"qrcode.oneOf.0","typeLabel":"string"},{"type":"null","description":"QR Code da instância, caso disponível.","example":null,"uniqueKey":"qrcode.oneOf.1","typeLabel":"null"}],"uniqueKey":"qrcode","typeLabel":"string | null"},"lookup_key":{"type":"string","description":"Identificador de pesquisa criado anteriormente.","example":"ins_8j7wlxmpjlixx9mux5","uniqueKey":"lookup_key","typeLabel":"string"}},"required":["created_at","id","metadata","name","owner","settings","status","webhooks"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"created_at":"2024-10-03T21:56:22.620Z","id":"xy9rexnkwobmgg3tehgvs","metadata":{"customer_id":"123456","customer_name":"Joãozinho","phone_number":"+5587989075555"},"name":"MyNewInstance2","owner":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","display_name":null},"settings":{"call_rejection":"all","delay_per_word":true,"delete_chat_after_sent":true,"message_delay":{"enabled":true,"max":10,"min":1},"presence_behavior":"only_composing","read_confirmation":"never"},"status":"disconnected","webhooks":[{"enabled":true,"events":["message.received"],"id":"2nenz69l0xbf0m3uu9tfo","name":"Webhook Name","test_mode":false,"url":"https://webhook.mydomain.com","test_url":null}],"connection_type":"unofficial","qrcode":null,"lookup_key":"ins_8j7wlxmpjlixx9mux5"}}},"exampleType":"generated"}},"exampleType":"generated"},"eed2780a-0002-4894-b615-4f344658a496":{"description":"Erro de validação no corpo da requisição","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Código do erro de validação","example":"invalid_type","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Mensagem de erro","example":"Expected string, received null","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"path":{"type":"string","description":"Caminho do campo inválido no corpo da requisição","example":"name","uniqueKey":"errors.items.[INDEX].path","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"invalid_type","message":"Expected string, received null","path":"name"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"81c056d4-10f6-4fa9-9bbc-156b745d3719":{"description":"Instância não encontrada ou não pertence ao usuário","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","example":"instance_not_found","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","example":"Instance not found.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"instance_not_found","message":"Instance not found."}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"fc55a784-da9f-4cf5-91e3-ec51b7408152":{"bearer":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearer"}}},"servers":{"47a9c70c-c4df-478d-b870-e68c65cdee2a":{"url":"https://api.zapsterapi.com/v1","description":"Produção"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"pt-BR/v1/openapi/openapi.json"},"subdomain":"zapsterapi","siteName":"Zapster API","title":"Atualizando a Instância - Zapster API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"pt-BR":{"href":"/pt-BR/v1/api-reference/instance/update-instance","matchLevel":0},"en":{"href":"/en/v1/introduction","matchLevel":4}}},"lastModified":"2026-08-01T01:13:09.664Z","originalFileLocation":"pt-BR/v1/api-reference/instance/update-instance.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=\"Atualiza os dados da instância na plataforma, como o nome e os metadados.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Zapster API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/zapsterapi/cT0sfMuuEnMLr0h-/_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/zapsterapi/cT0sfMuuEnMLr0h-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/zapsterapi/cT0sfMuuEnMLr0h-/_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/zapsterapi/cT0sfMuuEnMLr0h-/_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/zapsterapi/cT0sfMuuEnMLr0h-/_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/zapsterapi/cT0sfMuuEnMLr0h-/_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/zapsterapi/cT0sfMuuEnMLr0h-/_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/zapsterapi/cT0sfMuuEnMLr0h-/_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/zapsterapi/cT0sfMuuEnMLr0h-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Atualizando a Instância - Zapster API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Atualiza os dados da instância na plataforma, como o nome e os metadados.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Zapster API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.zapsterapi.com/pt-BR/v1/api-reference/instance/update-instance\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://zapsterapi.mintlify.app/_mintlify/api/og/v2?division=Inst%C3%A2ncias\u0026amp;title=Atualizando+a+Inst%C3%A2ncia\u0026amp;description=Atualiza+os+dados+da+inst%C3%A2ncia+na+plataforma%2C+como+o+nome+e+os+metadados.%0A\u0026amp;theme=6d793348c5ecf1343e906422\u0026amp;signature=d5e713343894d47dab0cfce22769437cca660d717acd311c7ce118c5d84e320d\">\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=\"Atualizando a Instância - Zapster API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Atualiza os dados da instância na plataforma, como o nome e os metadados.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://zapsterapi.mintlify.app/_mintlify/api/og/v2?division=Inst%C3%A2ncias\u0026amp;title=Atualizando+a+Inst%C3%A2ncia\u0026amp;description=Atualiza+os+dados+da+inst%C3%A2ncia+na+plataforma%2C+como+o+nome+e+os+metadados.%0A\u0026amp;theme=6d793348c5ecf1343e906422\u0026amp;signature=d5e713343894d47dab0cfce22769437cca660d717acd311c7ce118c5d84e320d\">\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/zapsterapi/cT0sfMuuEnMLr0h-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Zapster API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.zapsterapi.com/pt-BR/v1/api-reference/instance/update-instance\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/pt-BR/v1/api-reference/instance/update-instance.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.zapsterapi.com/#organization\",\"name\":\"Zapster API\",\"url\":\"https://developer.zapsterapi.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/zapsterapi/hkJBRd8211Vh6izL/logo/light.svg?fit=max\u0026auto=format\u0026n=hkJBRd8211Vh6izL\u0026q=85\u0026s=7f89e972a4a31e307a18ba827099ba54\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.zapsterapi.com#website\",\"name\":\"Zapster API\",\"url\":\"https://developer.zapsterapi.com\",\"publisher\":{\"@id\":\"https://developer.zapsterapi.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.zapsterapi.com/pt-BR/v1/api-reference/instance/update-instance#webpage\",\"url\":\"https://developer.zapsterapi.com/pt-BR/v1/api-reference/instance/update-instance\",\"name\":\"Atualizando a Instância\",\"description\":\"Atualiza os dados da instância na plataforma, como o nome e os metadados.\",\"dateModified\":\"2026-08-01T01:13:09.664Z\",\"isPartOf\":{\"@id\":\"https://developer.zapsterapi.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.zapsterapi.com/pt-BR/v1/api-reference/instance/update-instance#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.zapsterapi.com/pt-BR/v1/api-reference/instance/update-instance#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Instâncias\",\"item\":\"https://developer.zapsterapi.com/pt-BR/v1/api-reference/instance/list-instances\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Atualizando a Instância\",\"item\":\"https://developer.zapsterapi.com/pt-BR/v1/api-reference/instance/update-instance\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.zapsterapi.com/pt-BR/v1/api-reference/instance/update-instance#apireference\",\"headline\":\"Atualizando a Instância\",\"name\":\"Atualizando a Instância\",\"description\":\"Atualiza os dados da instância na plataforma, como o nome e os metadados.\",\"url\":\"https://developer.zapsterapi.com/pt-BR/v1/api-reference/instance/update-instance\",\"mainEntityOfPage\":{\"@id\":\"https://developer.zapsterapi.com/pt-BR/v1/api-reference/instance/update-instance#webpage\"},\"dateModified\":\"2026-08-01T01:13:09.664Z\",\"publisher\":{\"@id\":\"https://developer.zapsterapi.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.zapsterapi.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Zapster API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Zapster API","nav":{"global":null,"languages":[{"language":"pt-BR","default":true,"tabs":[{"tab":"Visão Geral","icon":"book-open","pages":[{"title":"Visão Geral","href":"/pt-BR/v1/introduction"}]},{"tab":"Referência da API","icon":"square-terminal","pages":[{"group":"Instâncias","pages":[{"title":"Listando Instâncias","openapi":"GET /wa/instances","href":"/pt-BR/v1/api-reference/instance/list-instances"},{"title":"Criando Instância","openapi":"POST /wa/instances","href":"/pt-BR/v1/api-reference/instance/create-instance"},{"title":"Dados da Instância","openapi":"GET /wa/instances/{instance_id}","href":"/pt-BR/v1/api-reference/instance/instance-details"},{"title":"Excluindo Instância","openapi":"DELETE /wa/instances/{instance_id}","href":"/pt-BR/v1/api-reference/instance/delete-instance"},{"title":"Obtendo QR Code","openapi":"GET /wa/instances/{instance_id}/qrcode","href":"/pt-BR/v1/api-reference/instance/instance-qrcode"},{"title":"Obtendo Cód. Pareamento","openapi":"POST /wa/instances/{instance_id}/pairing-code","href":"/pt-BR/v1/api-reference/instance/pairing-code"},{"title":"Reconectando uma Instância WABA","openapi":"POST /wa/instances/{instance_id}/reconnect","href":"/pt-BR/v1/api-reference/instance/reconnect-instance"},{"title":"Migrando o Tipo de Conexão","openapi":"POST /wa/instances/{instance_id}/migrate","href":"/pt-BR/v1/api-reference/instance/migrate-instance"},{"title":"Criando Webhooks","openapi":"POST /wa/instances/{instance_id}/webhooks","href":"/pt-BR/v1/api-reference/instance/create-webhook"},{"title":"Atualizando Webhooks","openapi":"PATCH /wa/instances/{instance_id}/webhooks/{webhook_id}","href":"/pt-BR/v1/api-reference/instance/update-webhook"},{"title":"Excluindo Webhooks","openapi":"DELETE /wa/instances/{instance_id}/webhooks/{webhook_id}","href":"/pt-BR/v1/api-reference/instance/delete-webhook"},{"title":"Ligando Instância","openapi":"POST /wa/instances/{instance_id}/power-on","href":"/pt-BR/v1/api-reference/instance/power-instance-on"},{"title":"Desligando Instância","openapi":"POST /wa/instances/{instance_id}/power-off","href":"/pt-BR/v1/api-reference/instance/power-instance-off"},{"title":"Reiniciando Instância","openapi":"POST /wa/instances/{instance_id}/restart","description":"","href":"/pt-BR/v1/api-reference/instance/restart-instance"},{"title":"Atualizando a Instância","openapi":"PATCH /wa/instances/{instance_id}","href":"/pt-BR/v1/api-reference/instance/update-instance"},{"title":"Atualizando Perfil","openapi":"PATCH /wa/instances/{instance_id}/profile","description":"","href":"/pt-BR/v1/api-reference/instance/update-profile"},{"title":"Atualizando Configurações","openapi":"PATCH /wa/instances/{instance_id}/settings","href":"/pt-BR/v1/api-reference/instance/update-settings"}]},{"group":"Confirmações","pages":[{"title":"Pré-autorizando uma Confirmação","openapi":"POST /confirmations","href":"/pt-BR/v1/api-reference/confirmations/issue-confirmation"}]},{"group":"Webhooks","pages":[{"title":"Listar Webhooks","openapi":"GET /webhooks","href":"/pt-BR/v1/api-reference/webhooks/list-webhooks"},{"title":"Atualizar Webhook","openapi":"PATCH /webhooks/{webhook_id}","href":"/pt-BR/v1/api-reference/webhooks/update-webhook"},{"title":"Excluir Webhook","openapi":"DELETE /webhooks/{webhook_id}","href":"/pt-BR/v1/api-reference/webhooks/delete-webhook"}]},{"group":"Mensagens","pages":[{"title":"Enviando Mensagens","openapi":"POST /wa/messages","href":"/pt-BR/v1/api-reference/messages/sending"},{"title":"Cancelar Mensagem Agendada","openapi":"DELETE /wa/messages/{id}","href":"/pt-BR/v1/api-reference/messages/cancel-message"},{"title":"Marcar Mensagem como Lida","openapi":"POST /wa/messages/{id}/read","href":"/pt-BR/v1/api-reference/messages/read-message"},{"title":"Marcar Mensagens como Lidas (Lote)","openapi":"POST /wa/messages/read","href":"/pt-BR/v1/api-reference/messages/read-messages-batch"},{"title":"Listar Mensagens","openapi":"GET /wa/messages","href":"/pt-BR/v1/api-reference/messages/list-messages"}]},{"group":"Para Grupos","pages":[{"title":"Listar Grupos","openapi":"GET /wa/instances/{instance_id}/groups","href":"/pt-BR/v1/api-reference/groups/fetch-all"},{"title":"Criar um Grupo","openapi":"POST /wa/instances/{instance_id}/groups","href":"/pt-BR/v1/api-reference/groups/create"},{"title":"Atualizar um Grupo","openapi":"PATCH /wa/instances/{instance_id}/groups/{group_id}","href":"/pt-BR/v1/api-reference/groups/update-data"},{"title":"Listar Participantes","openapi":"GET /wa/instances/{instance_id}/groups/{group_id}/participants","href":"/pt-BR/v1/api-reference/groups/fetch-participants"},{"title":"Adicionar Participantes","openapi":"POST /wa/instances/{instance_id}/groups/{group_id}/participants","href":"/pt-BR/v1/api-reference/groups/add-participants"},{"title":"Remover Participantes","openapi":"DELETE /wa/instances/{instance_id}/groups/{group_id}/participants","href":"/pt-BR/v1/api-reference/groups/delete-participants"},{"title":"Rebaixar Participantes","openapi":"DELETE /wa/instances/{instance_id}/groups/{group_id}/demote-participants","href":"/pt-BR/v1/api-reference/groups/demote-participants"},{"title":"Entrar em Grupos","openapi":"POST /wa/instances/{instance_id}/groups/join","href":"/pt-BR/v1/api-reference/groups/join-group"},{"title":"Promover Participantes","openapi":"POST /wa/instances/{instance_id}/groups/{group_id}/promote-participants","href":"/pt-BR/v1/api-reference/groups/promote-participants"}]},{"group":"Utilidades","pages":[{"title":"Verificação de Número (Sem Instância)","openapi":"GET /wa/recipients/{recipient}","href":"/pt-BR/v1/api-reference/utils/check-recipient"},{"title":"Verificação de Números em Lote (Sem Instância)","openapi":"POST /wa/recipients/batch","href":"/pt-BR/v1/api-reference/utils/check-recipient-batch"},{"title":"Verificação de Número","openapi":"GET /wa/instances/{instance_id}/recipients/{recipient}","href":"/pt-BR/v1/api-reference/utils/fetch-recipient"},{"title":"Verificação de Números em Lote","openapi":"POST /wa/instances/{instance_id}/recipients/batch","href":"/pt-BR/v1/api-reference/utils/fetch-recipient-batch"},{"title":"Atualização de Presença","openapi":"PATCH /wa/instances/{instance_id}/presence","href":"/pt-BR/v1/api-reference/utils/presence-update"},{"title":"Foto de Perfil do Destinatário","openapi":"GET /wa/recipients/{recipient}/pp","href":"/pt-BR/v1/api-reference/utils/recipient-profile-picture"}]}]},{"tab":"CLI","icon":"terminal","pages":[{"title":"CLI","href":"/pt-BR/v1/cli/introduction"}]},{"tab":"Blog","icon":"newspaper","href":"https://blog.zapsterapi.com/?utm_source=Documentation\u0026utm_medium=DropdownNavigation"}]},{"language":"en","pages":[{"title":"en","href":"/en/v1/introduction"}]}]},"title":"Atualizando a Instância - Zapster API","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}