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)

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): Intervalo do resumo em minutos, um de 15, 30, 60, 120, 180, 240, 720 ou 1440; qualquer outro valor retorna 400. Se omitido, volta para a cadência mais rápida que o plano permite, então envie o valor atual quando só alternar enabled.

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.

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, ou code: "token_issuer_lost_access" quando a pessoa que criou a chave API foi desativada ou saiu do workspace.
  • 403 Forbidden: code: "subscription_required" quando o plano do workspace não inclui acesso à API, code: "workspace_access_denied" quando X-Workspace-Id indica um workspace que esta credencial não pode alcançar, ou code: "permission_denied" quando seu papel no workspace não tem a permissão redreplier.write (Admin e Editor têm).
  • 404 Not Found: O recurso não existe para a conta do token.
  • 429 Too Many Requests: Limite de requisições excedido. Aguarde os segundos indicados em Retry-After.
  • 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, 120, 180, 240, 720, 1440]
}