[DELETE] Remover variável

Remove uma variável existente de um agente. Essa operação é permanente e não pode ser desfeita.


Endpoint

DELETE /v1.1/api/agent-service-data-of-interest/remove


Autenticação

  • Tipo: Bearer Token

  • Header: Authorization: Bearer <API_KEY>

  • Obrigatório: Sim


Requisição

Método HTTP

DELETE

Parâmetros de Query

Campo
Tipo
Obrigatório
Descrição

agentId

number

Sim

ID do agente que possui a configuração

id

string

Sim

Identificador único da configuração a ser removida

Exemplo

{
  "agentId": 15792,
  "id": "doi_12345"
}

📤 Exemplo de Requisição (cURL)

curl --location --request DELETE 'https://api.zaia.app/v1.1/api/agent-service-data-of-interest/remove?agentId=15792&id=doi_12345' \
--header 'Authorization: Bearer <API_KEY>'

📥 Respostas

✅ 200 - Sucesso

null

❌ 404 - Não encontrado

"Agent not found"

❌ 401 - Unauthorized

"Unauthorized - Invalid or missing API key"

Códigos de Resposta

Status
Descrição

200

Data of interest removida com sucesso

404

Agente não encontrado ou inacessível para o usuário autenticado

401

API key inválida ou ausente


Notas

  • O agente deve pertencer ao time/usuário associado à API key.

  • O agente precisa estar com status ativo.

  • A operação é permanente e não pode ser desfeita.

  • Se o id não existir, a operação pode retornar sucesso (comportamento idempotente).

Atualizado