Atualizando a Instância
Atualiza os dados da instância na plataforma, como o nome e os metadados.
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.
Atualize só o que precisar
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 aceitanull: 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.
Como o metadata é atualizado
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
"".
customer_id, customer_name e campaign, a requisição abaixo altera customer_id, limpa campaign e mantém customer_name intacto:
Chaves reservadas wa_
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.Autorizações
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Parâmetros de caminho
ID da instância.
Corpo
Nome da instância na plataforma. Sempre um texto, nunca null.
"Minha Instância"
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.
32"ins_8j7wlxmpjlixx9mux5"
Resposta
Success
Estrutura de uma instância registrada na API.
Data e hora de criação da instância no formato ISO 8601.
"2024-10-03T21:56:22.620Z"
Identificador único da instância.
"xy9rexnkwobmgg3tehgvs"
Metadados adicionais armazenados como chave e valor.
Nome da instância.
"MyNewInstance2"
Informações sobre o proprietário da instância.
Objeto opcional de configurações da sua instância.
Status atual da instância
connected, disconnected, offline "disconnected"
Lista de webhooks configurados para esta instância.
Tipo de conexão da instância:
unofficial: conexão via QR code (padrão)waba: conexão via API oficial do WhatsApp (Cloud API da Meta)
unofficial, waba "unofficial"
QR Code da instância, caso disponível.
null
Identificador de pesquisa criado anteriormente.
"ins_8j7wlxmpjlixx9mux5"