Referencia de APIPUT

Actualizar configuración de alertas

Activa o desactiva alertas por correo y define su cadencia.

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

Activa o desactiva alertas por correo y define su cadencia.

Token Bearer (token de API de RedReplier)

Autenticación

Envía un token de API de RedReplier como Bearer token en cada solicitud. Los tokens empiezan por redreplier_; RedReplier resuelve la cuenta desde el token.

Authorization: Bearer redreplier_test_1234567890
Content-Type: application/json

Parámetros

Este endpoint no acepta parámetros de ruta ni de consulta.

Cuerpo de la solicitud

  • enabled (booleano, obligatorio): Activa o desactiva alertas por correo.
  • cadenceMinutes (entero, opcional): Cadencia deseada. Valores comunes permitidos: 60, 240, 720 y 1440; la respuesta incluye los valores disponibles para el plan actual.

Respuesta

Devuelve la configuración de alertas de la cuenta del token.

  • enabled (boolean): Indica si las alertas por correo están activadas.
  • cadenceMinutes (number): Cadencia configurada de alertas en minutos.
  • minIntervalMinutes (number): Cadencia más rápida permitida por el plan actual.
  • availableCadences (number[]): Valores de cadencia disponibles para el plan actual.

Solicitud de ejemplo

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

Si la cadencia solicitada es más rápida que lo permitido por el plan, RedReplier la ajusta a minIntervalMinutes.

Errores

  • 400 Bad Request: Entrada, URL, UUID, enum, parámetro de consulta o cuerpo no válido.
  • 401 Unauthorized: Bearer token ausente o no válido.
  • 404 Not Found: El recurso no existe para la cuenta del token.
  • 500 Internal Server Error: Error inesperado del servidor.
Solicitud de ejemplo (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]
}