Atualizando Configurações
Atualiza as configurações de comportamento da instância (rejeição de ligações, delay de envio, presença, limpeza de conversa e confirmação de leitura automática).
A atualização é um merge profundo com as configurações atuais: apenas os campos enviados no corpo são alterados, os demais são preservados. Em objetos aninhados, como message_delay e o formato segmentado de read_confirmation, o merge acontece campo a campo, então enviar { "read_confirmation": { "chats": true } } liga a confirmação de leitura em conversas individuais sem alterar groups ou status.
A mudança é propagada para a instância em tempo real, sem necessidade de reiniciá-la.
Atualize só o que precisar
Você não precisa enviar todas as configurações a cada chamada. Envie apenas o que quer mudar e tudo o que ficar de fora continua exatamente como está. Isso vale até para configurações com subcampos, comomessage_delay e o formato segmentado de read_confirmation: cada subcampo que você não enviar também fica como estava. Por exemplo, enviando apenas:
groups e status seguem do jeito que estavam.
Configurações disponíveis
call_rejection: define se ligações recebidas devem ser rejeitadas automaticamente. Aceitaall(rejeita todas),none(não rejeita nenhuma),video_only(rejeita apenas chamadas de vídeo) ouaudio_only(rejeita apenas chamadas de áudio).message_delay: adiciona um atraso proposital antes do envio de cada mensagem, útil para simular um comportamento mais humano. É um objeto comenabled(liga/desliga o delay),minemax(limites em segundos, o tempo real é sorteado dentro desse intervalo).delay_per_word: quando ligado, o delay antes do envio passa a ser calculado com base na quantidade de palavras da mensagem, até um teto de 10 segundos. Quandomessage_delayestá configurado, ele tem prioridade edelay_per_wordé ignorado.presence_behavior: controla quando a instância aparece como “online” para os contatos.only_composingmostra “online” apenas durante o envio da mensagem (recomendado),always_onlinemantém a instância sempre online ealways_offlineevita aparecer online exceto quando necessário para o envio.delete_chat_after_sent: quando ligado, limpa a conversa no aparelho logo depois do envio da mensagem, para evitar acúmulo de histórico no dispositivo conectado.read_confirmation: controla a confirmação de leitura automática das mensagens recebidas. Aceita os valoresnever(nunca confirma) oualways(sempre confirma), ou um objeto segmentado por tipo de conversa com os camposchats,groupsestatus, cada um booleano e independente. Quando o segmentostatusestá ligado, os status publicados pelos seus contatos são marcados como vistos assim que recebidos. Mensagens enviadas pela própria instância, listas de transmissão e publicações de canais nunca recebem confirmação automática, independentemente dessa configuração.
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
Objeto opcional de configurações da sua instância.
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"