Alterar agente

PUT/v1/instances/{id}/attendant/agents/{agent_id}desde M5btoken da instância ou admin

Quando usar

Substitui o perfil inteiro (um roteiro vazio fica vazio).

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
idobrigatório	string	Id da instância (inst_...).
agent_idobrigatório	string	Id do agente (agt_...).

Corpo (JSON)

Nome	Tipo	Descrição
nameobrigatório	string	(até 80)
mode	"vendedor" | "pedido" | "sdr" | "suporte" | "custom"
objective	string
steps	string[]
tone	string
handoff_criteria	string[]
actions	"handoff" | "lead" | "appointment" | "order_draft"[]
business	string	Contexto do negócio (texto livre
knowledge	object[]	(até 300 itens)
language	string	(padrão "pt-BR")
currency	string	(padrão "BRL")
voice_reply	"off" | "when_audio" | "always"	(padrão "off")
call_followup	boolean
call_hint	string
max_reply_chars	integer	(padrão 1000, 50–4000)
hide_contact_name	boolean

Exemplo

cURL

curl -s -X PUT "$LITEZAP_URL/v1/instances/$ID/attendant/agents/$AGENT_ID" \
  -H "Authorization: Bearer $LITEZAP_TOKEN"

Node.js

const res = await fetch("http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/attendant/agents/agent_id", {
  method: "PUT",
  headers: { Authorization: `Bearer ${process.env.LITEZAP_TOKEN}` },
});
console.log(res.status, res.status === 204 ? "" : await res.json());

Python

import os
import requests

r = requests.put(
    "http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/attendant/agents/agent_id",
    headers={"Authorization": f"Bearer {os.environ['LITEZAP_TOKEN']}"},
    timeout=150,
)
print(r.status_code, r.json() if r.content else "")

Go

package main

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

func main() {
  req, _ := http.NewRequest("PUT", "http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/attendant/agents/agent_id", nil)
  req.Header.Set("Authorization", "Bearer "+os.Getenv("LITEZAP_TOKEN"))
  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

<?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/attendant/agents/agent_id', [
    'headers' => ['Authorization' => 'Bearer ' . getenv('LITEZAP_TOKEN')],
    '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 Agente alterado.

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).
not_found	404	não	Confira o id do recurso (mensagem, chat, contato, mídia ou webhook).
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.

Outras operações de Atendente IA: Ler hook de agente · Configurar hook de agente · Remover hook de agente · Ligar ou desligar o atendente numa conversa · Últimas chamadas do atendente · Ler o Atendente LiteZap · Configurar provedor do atendente · Modos prontos do atendente · Listar agentes · Criar agente · Ler agente · Excluir agente · Ativar agente · Simular conversa · Uso e custo do atendente