Definir clientes de um monitoramento

Substitui os clientes do monitoramento informado em monitoringId.

A lista enviada é a lista completa: quem não estiver nela sai do monitoramento. Para incluir clientes, envie os atuais junto com os novos. Quem entra é consultado na próxima rodada agendada de cada módulo; não há consulta imediata. Os alertas de quem sai deixam de contar.

Um cliente que volta recupera os alertas da rodada mais recente de cada módulo ligado. Depois da troca, o status é recalculado: com clientes, módulo ligado e período válido, um DRAFT ou ENDED volta a SCHEDULED; sem módulo ligado ou com o período vencido, o monitoramento vai para DRAFT, e um ENDED com o período vencido continua ENDED. O histórico registra a troca de clientes e a passagem para DRAFT (MONITORING_DRAFTED); a volta para SCHEDULED não é registrada. A resposta traz só a nova quantidade de clientes (clientsCount).

Os clientes precisam ser pessoas físicas ou jurídicas da empresa e não estar excluídos da base de clientes; IDs repetidos contam uma vez.

Só quem criou o monitoramento pode alterar os clientes, e um monitoramento INACTIVE precisa ser reativado antes. 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

Clientes definidos

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Sem permissão para editar monitoramentos

🟠403Acesso negado

🟠404Monitoramento não encontrado

🟠422Corpo ou regra inválidos

curl --location '/v2/monitoring/9c1e4b7a-0000-4000-8000-000000000d04/clients' \ --header 'x-api-key: SUA_CHAVE_DE_API' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "clientIds": [ "7c9e6679-7425-40de-944b-e07fc1f90ae7", "4a1b2c3d-0000-4000-8000-000000000c03" ] }'

Definir clientes de um monitoramento

Requisição

Respostas