Pular para o conteúdo principal
PUT
/
instances
/
{instanceId}
/
token
/
{token}
/
update-queue-settings
Atualizar configuração da fila
curl --request PUT \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/update-queue-settings \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "disableEnqueueWhenDisconnected": true
}
'

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Este método permite atualizar configurações relacionadas ao comportamento da fila de mensagens da instância. Atualmente, é possível configurar se a instância deve ou não aceitar novas mensagens na fila enquanto estiver desconectada.

​
Atributos

​
Obrigatórios

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Body (Obrigatórios)

​
disableEnqueueWhenDisconnected
boolean
Define se a instância deve bloquear o enfileiramento de mensagens quando estiver desconectada.

​
Request Body

{
  "disableEnqueueWhenDisconnected": true
}

​
Comportamento da fila

  • Por padrão, a Z-API permite o envio de mensagens para a fila mesmo quando a instância não possui um número conectado
  • Quando disableEnqueueWhenDisconnected for true, novas mensagens não serão adicionadas à fila enquanto a instância estiver desconectada
  • Quando disableEnqueueWhenDisconnected for false, o comportamento padrão é mantido (mensagens continuam sendo enfileiradas mesmo desconectado)
  • Essa configuração é útil para evitar o acúmulo de mensagens na fila quando a instância é reutilizada sem um número conectado

​
Response

​
200

{
  "success": true
}

​
405

Neste caso, certifique-se de que está utilizando o método correto (PUT) conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, verifique se o header “Content-Type” foi definido corretamente como “application/json”.