Référence de l'APIPUT

Mettre à jour les paramètres d’alerte

Active ou désactive les alertes e-mail pour les nouvelles mentions pertinentes et définit leur fréquence d’envoi.

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

Active ou désactive les alertes e-mail pour les nouvelles mentions pertinentes et définit leur fréquence d’envoi.

Jeton Bearer (jeton API RedReplier)

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): Intervalle du digest en minutes, parmi 15, 30, 60, 120, 180, 240, 720 ou 1440; toute autre valeur renvoie 400. Omis, il revient à la cadence la plus rapide permise par l'abonnement: envoyez donc la valeur actuelle si vous ne changez que enabled.

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.

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, ou code: "token_issuer_lost_access" quand la personne qui a créé la clé API a été désactivée ou a quitté l'espace de travail.
  • 403 Forbidden: code: "subscription_required" quand l'abonnement de l'espace de travail n'inclut pas l'accès à l'API, code: "workspace_access_denied" quand X-Workspace-Id désigne un espace de travail que ces identifiants ne peuvent pas atteindre, ou code: "permission_denied" quand votre rôle dans l'espace de travail n'a pas la permission redreplier.write (Admin et Editor l'ont).
  • 404 Not Found: La ressource n’existe pas pour le compte du token.
  • 429 Too Many Requests: Limite de débit dépassée. Attendez le nombre de secondes indiqué dans Retry-After.
  • 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, 120, 180, 240, 720, 1440]
}