Référence de l'APIPUT

Mettre à jour les paramètres d’alerte

Active ou désactive les alertes e-mail et définit leur cadence.

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

Active ou désactive les alertes e-mail et définit leur cadence.

Jeton Bearer (jeton API RedReplier)

Authentification

Envoyez un token API RedReplier comme Bearer token à chaque requête. Les tokens commencent par redreplier_; RedReplier résout le compte depuis le token.

Authorization: Bearer redreplier_test_1234567890
Content-Type: application/json

Paramètres

Cet endpoint ne prend aucun paramètre de chemin ou de requête.

Corps de la requête

  • enabled (booléen, requis): Active ou désactive les alertes e-mail.
  • cadenceMinutes (entier, facultatif): Cadence souhaitée. Les valeurs courantes sont 60, 240, 720 et 1440; la réponse inclut les valeurs actuellement disponibles pour l’abonnement.

Réponse

Renvoie les paramètres d’alerte du compte lié au token.

  • enabled (boolean): Indique si les alertes e-mail sont activées.
  • cadenceMinutes (number): Cadence d’alerte configurée en minutes.
  • minIntervalMinutes (number): Cadence la plus rapide autorisée par l’abonnement actuel.
  • availableCadences (number[]): Valeurs de cadence disponibles pour l’abonnement actuel.

Exemple de requête

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}'

Notes

Si la cadence demandée est plus rapide que ce que l’abonnement permet, RedReplier la ramène à minIntervalMinutes.

Erreurs

  • 400 Bad Request: Entrée, URL, UUID, enum, paramètre de requête ou corps non valide.
  • 401 Unauthorized: Bearer token manquant ou non valide.
  • 404 Not Found: La ressource n’existe pas pour le compte du token.
  • 500 Internal Server Error: Erreur serveur inattendue.
Exemple de requête (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]
}