Referência da APIPUT

Atualizar configurações de alerta

Ativa ou desativa os alertas por e-mail para novas menções relevantes e define com que frequência são enviados.

PUThttps://ai.redreplier.com/ai-app/api/v1/alert-settings

Ativa ou desativa os alertas por e-mail para novas menções relevantes e define com que frequência são enviados.

Token Bearer (token de API do RedReplier)

Autenticação

Envie um token de API do RedReplier como Bearer token em cada requisição. Os tokens começam com redreplier_; o RedReplier resolve a conta a partir do token.

Authorization: Bearer redreplier_test_1234567890
Content-Type: application/json

Parâmetros

Este endpoint não aceita parâmetros de caminho nem de consulta.

Corpo da requisição

  • enabled (booleano, obrigatório): Ativa ou desativa alertas por e-mail.
  • cadenceMinutes (inteiro, opcional): Cadência desejada. Valores comuns permitidos são 60, 240, 720 e 1440; a resposta inclui os valores disponíveis para o plano atual.

Resposta

Retorna as configurações de alerta da conta do token.

  • enabled (boolean): Indica se alertas por e-mail estão ativados.
  • cadenceMinutes (number): Cadência de alerta configurada em minutos.
  • minIntervalMinutes (number): Cadência mais rápida permitida pelo plano atual.
  • availableCadences (number[]): Valores de cadência disponíveis para o plano atual.

Exemplo de requisição

curl -X PUT https://ai.redreplier.com/ai-app/api/v1/alert-settings \
  -H 'Authorization: Bearer redreplier_test_1234567890' \
  -H 'Content-Type: application/json' \
  -d '{"enabled":true,"cadenceMinutes":240}'

Notas

Se a cadência solicitada for mais rápida do que o plano permite, o RedReplier ajusta para minIntervalMinutes.

Erros

  • 400 Bad Request: Entrada, URL, UUID, enum, parâmetro de consulta ou corpo inválido.
  • 401 Unauthorized: Bearer token ausente ou inválido.
  • 404 Not Found: O recurso não existe para a conta do token.
  • 500 Internal Server Error: Erro inesperado do servidor.
Exemplo de solicitação (curl)
curl --request PUT \
  --url https://ai.redreplier.com/ai-app/api/v1/alert-settings \
  --header 'Authorization: Bearer redreplier_test_1234567890' \
  --header 'Content-Type: application/json' \
  --data '{"enabled":true,"cadenceMinutes":240}'
200
{
  "enabled": true,
  "cadenceMinutes": 240,
  "minIntervalMinutes": 60,
  "availableCadences": [60, 240, 720, 1440]
}