Atualizar monitoramento

Altera a configuração do monitoramento informado em monitoringId.

O corpo substitui a configuração: modules lista os módulos que ficam ligados, e só aceita módulos que o monitoramento já tem; não é possível adicionar módulos. Um módulo que não vem em modules é desligado, e os alertas dele deixam de contar; um módulo desligado que volta em modules é religado e recupera os alertas da rodada mais recente dele.

Um módulo indisponível no perfil de permissão do usuário fica como está, venha ou não em modules: os valores enviados para ele são ignorados e, se estiver desligado, ele não é religado. A próxima consulta de cada módulo enviado e disponível no perfil de permissão do usuário é recalculada: se o módulo nunca rodou, fica para startDate; se já rodou, para a última consulta mais frequencyDays ou, se essa data já passou, hoje mais frequencyDays.

O status é recalculado: sem clientes, sem módulo ligado ou com o período vencido, o monitoramento vai para DRAFT; um DRAFT ou ENDED que volta a ter tudo isso passa a SCHEDULED, e um ENDED com o período ainda vencido continua ENDED.

Entram no histórico do monitoramento as mudanças de período, a troca de frequência de um módulo e o ligar ou desligar de módulos, assim como a passagem para DRAFT (MONITORING_DRAFTED) ou de volta a SCHEDULED (MONITORING_REACTIVATED) causada pela edição. Mudanças de nome, descrição, alertEnabled, criterion e conditions não entram no histórico.

Só quem criou o monitoramento pode alterá-lo, e um monitoramento INACTIVE precisa ser reativado antes. startDate só muda enquanto nenhum módulo rodou e precisa ser a partir de amanhã; uma nova endDate não pode ser anterior a hoje. O nome não pode repetir o de outro monitoramento da empresa, sem diferenciar maiúsculas nem acentos. Monitoramento inexistente ou de outra empresa devolve 404 (Monitoria não encontrada.).

Requer autenticação via Bearer JWT ou header x-api-key e a permissão de editar monitoramentos. Usuário sem perfil de permissão recebe 403 (Acesso negado); perfil inexistente, 401 (Permissão inválida!); perfil sem a permissão, 400 (Permissão não encontrada); usuário inativo, 404 (Usuário não encontrado).

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Respostas

🟢200Sucesso

application/json

Configuração alterada

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Sem permissão para editar monitoramentos

🟠403Acesso negado

🟠404Monitoramento não encontrado

🟠409Nome já usado

🟠422Corpo ou regra inválidos

curl --location --request PATCH '/v2/monitoring/9c1e4b7a-0000-4000-8000-000000000d01' \ --header 'x-api-key: SUA_CHAVE_DE_API' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "Carteira safra 26/27", "description": "Produtores de soja do MT", "startDate": "2026-09-01", "endDate": "2027-08-31", "modules": [ { "moduleKey": "PROTESTS", "frequencyDays": 15, "criterion": "SPECIFIC_CHANGE", "conditions": { "logic": "OR", "conditions": [ { "field": "totalProtests", "operator": "GREATER_THAN", "value": 0 }, { "field": "totalValue", "operator": "GREATER_THAN_OR_EQUAL", "value": 50000 } ] } }, { "moduleKey": "JUDICIAL", "frequencyDays": 30 } ] }'

Atualizar monitoramento

Requisição

Respostas