Referencia de APIPUT

Actualizar configuración de alertas

Activa o desactiva las alertas por correo para nuevas menciones relevantes y define con qué frecuencia se envían.

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

Activa o desactiva las alertas por correo para nuevas menciones relevantes y define con qué frecuencia se envían.

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. Envía X-Workspace-Id para actuar en un workspace distinto del predeterminado; consulta Listar workspaces.

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): Intervalo del resumen en minutos, uno de 15, 30, 60, 120, 180, 240, 720 o 1440; cualquier otro valor devuelve 400. Si lo omites vuelve a la cadencia más rápida que permite el plan, así que envía el valor actual cuando solo cambies enabled.

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, o code: "token_issuer_lost_access" cuando la persona que creó la clave API fue desactivada o salió del workspace.
  • 403 Forbidden: code: "subscription_required" cuando el plan del workspace no incluye acceso a la API, code: "workspace_access_denied" cuando X-Workspace-Id indica un workspace al que esta credencial no puede acceder, o code: "permission_denied" cuando tu rol en el workspace no tiene el permiso redreplier.write (lo tienen Admin y Editor).
  • 404 Not Found: El recurso no existe para la cuenta del token.
  • 429 Too Many Requests: Límite de solicitudes superado. Espera los segundos indicados en Retry-After.
  • 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, 120, 180, 240, 720, 1440]
}