Skip to main content
PATCH
Atualização de Configurações
Use este endpoint para atualizar as configurações de comportamento da sua instância: rejeição de ligações, delay antes do envio de mensagens, presença (online/digitando), limpeza de conversa e confirmação de leitura automática.

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, como message_delay e o formato segmentado de read_confirmation: cada subcampo que você não enviar também fica como estava. Por exemplo, enviando apenas:
Você liga a confirmação de leitura automática só para conversas individuais, e groups e status seguem do jeito que estavam.

Configurações disponíveis

  • call_rejection: define se ligações recebidas devem ser rejeitadas automaticamente. Aceita all (rejeita todas), none (não rejeita nenhuma), video_only (rejeita apenas chamadas de vídeo) ou audio_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 com enabled (liga/desliga o delay), min e max (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. Quando message_delay está configurado, ele tem prioridade e delay_per_word é ignorado.
  • presence_behavior: controla quando a instância aparece como “online” para os contatos. only_composing mostra “online” apenas durante o envio da mensagem (recomendado), always_online mantém a instância sempre online e always_offline evita 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 valores never (nunca confirma) ou always (sempre confirma), ou um objeto segmentado por tipo de conversa com os campos chats, groups e status, cada um booleano e independente. Quando o segmento status está 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.
Se você precisa de controle fino sobre o momento exato da confirmação de leitura, por exemplo, marcar como lida só depois que um atendente responder, desligue a confirmação automática do segmento desejado e use o endpoint de leitura sob demanda para confirmar mensagem por mensagem. A atualização é aplicada à instância em tempo real, sem necessidade de reiniciá-la.

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

instance_id
string
obrigatório

ID da instância.

Corpo

application/json
settings
object

Objeto opcional de configurações da sua instância.

Resposta

Success

Estrutura de uma instância registrada na API.

created_at
string<date-time>
obrigatório

Data e hora de criação da instância no formato ISO 8601.

Exemplo:

"2024-10-03T21:56:22.620Z"

id
string
obrigatório

Identificador único da instância.

Exemplo:

"xy9rexnkwobmgg3tehgvs"

metadata
object
obrigatório

Metadados adicionais armazenados como chave e valor.

Exemplo:
name
string
obrigatório

Nome da instância.

Exemplo:

"MyNewInstance2"

owner
object
obrigatório

Informações sobre o proprietário da instância.

settings
object
obrigatório

Objeto opcional de configurações da sua instância.

status
enum<string>
obrigatório

Status atual da instância

Opções disponíveis:
connected,
disconnected,
offline
Exemplo:

"disconnected"

webhooks
object[]
obrigatório

Lista de webhooks configurados para esta instância.

connection_type
enum<string>

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)
Opções disponíveis:
unofficial,
waba
Exemplo:

"unofficial"

qrcode
string | null

QR Code da instância, caso disponível.

Exemplo:

null

lookup_key
string

Identificador de pesquisa criado anteriormente.

Exemplo:

"ins_8j7wlxmpjlixx9mux5"