Alterar configurações

PUT/v1/instances/{id}/settingsdesde M2token da instância ou admin

Quando usar

Atualização parcial: campos ausentes mantêm o valor atual. proxy_url e unsafe_pacing exigem o token admin (403 forbidden com token de instância). Pisos: min_interval_ms ≥ 1000 e max_per_minute ≤ 60, salvo unsafe_pacing. send_window com start e end vazios libera qualquer horário. "proxy_url": "" volta ao default_proxy_url. Trocar o proxy reinicia o worker.

Autenticação

Aceita o token da instância (só a própria instância) ou o token admin. Um token de outra instância recebe 403 forbidden (ou 404 not_found em webhooks de outra instância).

Parâmetros

Caminho

Nome	Tipo	Descrição
`id`obrigatório	`string`	Id da instância (`inst_...`).

Corpo (JSON)

Nome	Tipo	Descrição
`min_interval_ms`	`integer`
`jitter_ms`	`integer`
`max_per_minute`	`integer`
`typing_simulation`	`boolean`
`ramp`	`object`
`ramp.enabled`	`boolean`
`ramp.start_per_day`	`integer`
`ramp.end_per_day`	`integer`
`ramp.days`	`integer`
`send_window`	`SendWindow`
`send_window.start`	`string`	HH:MM; vazio com end vazio = sem janela.
`send_window.end`	`string`
`send_window.start`	`string`	HH:MM; vazio com end vazio = sem janela.
`send_window.end`	`string`
`timezone`	`string`
`unsafe_pacing`	`boolean`	Só admin.
`proxy_url`	`string`	Só admin. Vazio volta ao default_proxy_url.
`calls`	`object`
`calls.auto_reject`	`boolean`
`calls.reject_message`	`string`	(até 1000)
`presence`	`object`
`presence.online`	`boolean`
`groups`	`GroupLimits`	Cotas anti-ban de grupos por instância (marco 8). Tetos sobem só com `unsafe_pacing` (admin).
`groups.max_adds_per_hour`	`integer`	(padrão 10)
`groups.max_adds_per_day`	`integer`	(padrão 50)
`groups.max_creates_per_day`	`integer`	(padrão 3)
`groups.max_joins_per_day`	`integer`	(padrão 10)
`auto_read`	`object`
`auto_read.enabled`	`boolean`
`auto_read.groups`	`boolean`

Exemplo

curl -s -X PUT "$LITEZAP_URL/v1/instances/$ID/settings" \
  -H "Authorization: Bearer $LITEZAP_TOKEN" \
  -d '{"min_interval_ms":5000,"ramp":{"enabled":true},"send_window":{"start":"09:00","end":"18:00"},"timezone":"America/Sao_Paulo"}'

const res = await fetch("http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/settings", {
  method: "PUT",
  headers: { Authorization: `Bearer ${process.env.LITEZAP_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "min_interval_ms": 5000,
    "ramp": {
      "enabled": true
    },
    "send_window": {
      "start": "09:00",
      "end": "18:00"
    },
    "timezone": "America/Sao_Paulo"
  }),
});
console.log(res.status, res.status === 204 ? "" : await res.json());

import os
import requests

r = requests.put(
    "http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/settings",
    headers={"Authorization": f"Bearer {os.environ['LITEZAP_TOKEN']}"},
    json={
        "min_interval_ms": 5000,
        "ramp": {
            "enabled": True,
        },
        "send_window": {
            "start": "09:00",
            "end": "18:00",
        },
        "timezone": "America/Sao_Paulo",
    },
    timeout=150,
)
print(r.status_code, r.json() if r.content else "")

package main

import (
  "fmt"
  "io"
  "net/http"
  "os"
  "strings"
)

func main() {
  req, _ := http.NewRequest("PUT", "http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/settings", strings.NewReader(`{"min_interval_ms":5000,"ramp":{"enabled":true},"send_window":{"start":"09:00","end":"18:00"},"timezone":"America/Sao_Paulo"}`))
  req.Header.Set("Authorization", "Bearer "+os.Getenv("LITEZAP_TOKEN"))
  req.Header.Set("Content-Type", "application/json")
  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()
  out, _ := io.ReadAll(resp.Body)
  fmt.Println(resp.Status, string(out))
}

<?php
require 'vendor/autoload.php'; // composer require guzzlehttp/guzzle

$client = new GuzzleHttp\Client(['base_uri' => 'http://localhost:8787']);
$res = $client->request('PUT', '/v1/instances/inst_7f3a9c2e5b1d4086/settings', [
    'headers' => ['Authorization' => 'Bearer ' . getenv('LITEZAP_TOKEN')],
    'json' => [
        'min_interval_ms' => 5000,
        'ramp' => [
            'enabled' => true,
        ],
        'send_window' => [
            'start' => '09:00',
            'end' => '18:00',
        ],
        'timezone' => 'America/Sao_Paulo',
    ],
    'http_errors' => false,
]);
echo $res->getStatusCode(), ' ', $res->getBody(), PHP_EOL;

Nos exemplos, LITEZAP_URL é a URL base (ex.: http://localhost:8787) e o token vem deLITEZAP_TOKEN (instância) ou LITEZAP_ADMIN_TOKEN.

Resposta

200 Configurações efetivas depois da alteração.

Campos de Settings

`min_interval_ms`	`integer`	Intervalo mínimo entre envios. Mínimo 1000 sem unsafe_pacing.
`jitter_ms`	`integer`	Variação aleatória somada ao intervalo.
`max_per_minute`	`integer`	Teto por minuto. Máximo 60 sem unsafe_pacing.
`typing_simulation`	`boolean`	Mostra "digitando" antes de enviar (~50ms por caractere, até 5s).
`ramp`	`Ramp`
`ramp.enabled`	`boolean`
`ramp.start_per_day`	`integer`
`ramp.end_per_day`	`integer`
`ramp.days`	`integer`
`ramp.enabled`	`boolean`
`ramp.start_per_day`	`integer`
`ramp.end_per_day`	`integer`
`ramp.days`	`integer`
`send_window`	`SendWindow`
`send_window.start`	`string`	HH:MM; vazio com end vazio = sem janela.
`send_window.end`	`string`
`send_window.start`	`string`	HH:MM; vazio com end vazio = sem janela.
`send_window.end`	`string`
`timezone`	`string`	Fuso IANA (ex.: America/Sao_Paulo); vazio = fuso do servidor.
`unsafe_pacing`	`boolean`	Remove os pisos de ritmo. Só admin.
`proxy_url`	`string`	http://, https:// ou socks5://; senha mascarada na leitura.
`calls`	`CallSettings`	Política de chamadas recebidas (marco 7).
`calls.auto_reject`	`boolean`	Rejeita toda chamada individual assim que toca (< 3s); `call.received` sai com `rejected: true`. Chamadas em grupo só são informadas.
`calls.reject_message`	`string`	Mandada ao autor de chamadas individuais rejeitadas, pela fila (ritmo, janela, rampa); no máximo uma por contato a cada 10 min; expira em 1h. Vazio: sem mensagem.
`presence`	`PresenceSettings`	Presença da própria conta (marco 7).
`presence.online`	`boolean`	Marca a conta como disponível a cada conexão: necessário para `chat.presence` e `presence/subscribe`. Enquanto ligado, o celular deixa de mostrar notificações.
`groups`	`GroupLimits`	Cotas anti-ban de grupos por instância (marco 8). Tetos sobem só com `unsafe_pacing` (admin).
`groups.max_adds_per_hour`	`integer`
`groups.max_adds_per_day`	`integer`
`groups.max_creates_per_day`	`integer`
`groups.max_joins_per_day`	`integer`
`auto_read`	`AutoReadSettings`	Leitura automática (marco 9).
`auto_read.enabled`	`boolean`	Marca as mensagens recebidas como lidas 2 a 5s depois, em lote por chat, no máximo uma confirmação por segundo. Com a confirmação de leitura desligada na privacidade, o contato não vê os tiques azuis.
`auto_read.groups`	`boolean`	Também em grupos.

Erros

Código	HTTP	Retentável	O que fazer
`validation_failed`	400	não	Corrija o corpo ou os parâmetros; a `message` diz o campo.
`unauthorized`	401	não	Envie `Authorization: Bearer <token>` válido.
`forbidden`	403	não	Use o token certo (admin, ou o da própria instância).
`instance_not_found`	404	não	Confira o id da instância.

Todo erro usa o envelope {"error":{"code","message","retryable"}}. Tabela completa em Erros.

Equivalente na Z-API: Atualizar configurações da fila / Configurar proxy. Veja Migrar da Z-API.

Outras operações de Configurações: Ler configurações