Reten Docs
Operadores

Atualizar Operador

Atualizar os campos de um operador.

PATCH /api/operators/:id

Atualiza os campos de um operador.

Os metadados são mesclados, não substituídos: as chaves enviadas sobrescrevem as de mesmo nome, as não enviadas são mantidas, e enviar uma chave com null a remove. A mesclagem é recursiva (RFC 7386 JSON Merge Patch): os objetos aninhados são mesclados nível por nível, então você pode atualizar uma chave dentro de um objeto aninhado sem reenviar as irmãs. Qualquer outro valor substitui o anterior por completo, incluindo os arrays, que nunca são mesclados elemento a elemento. Enviar metadata: null esvazia o saco inteiro.

Auth: Obrigatória — permissão operator:manage

Parâmetros de Rota

ParâmetroTipoDescrição
idUUIDID do operador

Corpo da Requisição

Todos os campos são opcionais:

CampoTipoDescrição
namestringNome do operador
emailstringEndereço de e-mail
phonestringNúmero de telefone
is_activebooleanStatus ativo
metadataobjectJSON arbitrário, mesclado recursivamente; null o esvazia

Exemplo

curl -X PATCH https://api.reten.ai/api/operators/cc0e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Smith",
    "phone": "+56987654321",
    "metadata": { "region": "north" }
  }'
const operatorId = "cc0e8400-e29b-41d4-a716-446655440000";
const response = await fetch(`https://api.reten.ai/api/operators/${operatorId}`, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer <token>",
    "x-tenant-id": "<tenant-id>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "John Smith",
    phone: "+56987654321",
    metadata: { region: "north" },
  }),
});
const operator = await response.json();
import requests

operator_id = "cc0e8400-e29b-41d4-a716-446655440000"
response = requests.patch(
    f"https://api.reten.ai/api/operators/{operator_id}",
    headers={
        "Authorization": "Bearer <token>",
        "x-tenant-id": "<tenant-id>",
    },
    json={
        "name": "John Smith",
        "phone": "+56987654321",
        "metadata": {"region": "north"},
    },
)
operator = response.json()

Resposta 200 OK

Retorna o objeto do operador atualizado.