API-referentiePUT

Meldingsinstellingen bijwerken

Zet e-mailmeldingen over nieuwe relevante vermeldingen aan of uit en stel in hoe vaak RedReplier ze verstuurt.

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

Zet e-mailmeldingen over nieuwe relevante vermeldingen aan of uit en stel in hoe vaak RedReplier ze verstuurt.

Bearer-token (RedReplier API-token)

Authenticatie

Stuur bij elk verzoek een RedReplier API-token mee als Bearer-token. Tokens beginnen met redreplier_; RedReplier haalt het account uit het token. Stuur X-Workspace-Id mee om in een andere workspace dan de standaard te werken; zie Workspaces weergeven.

Authorization: Bearer redreplier_test_1234567890
Content-Type: application/json

Parameters

Dit endpoint heeft geen pad- of queryparameters.

Request body

  • enabled (boolean, verplicht): Zet e-mailmeldingen aan of uit.
  • cadenceMinutes (integer, optioneel): Interval van de samenvatting in minuten, een van 15, 30, 60, 120, 180, 240, 720 of 1440; elke andere waarde geeft een 400. Laat je het weg, dan wordt de frequentie teruggezet naar de snelste die het abonnement toestaat, dus stuur de huidige waarde mee als je alleen enabled omzet.

Respons

Geeft de meldingsinstellingen van het account van het token terug.

  • enabled (boolean): Of e-mailmeldingen aan staan.
  • cadenceMinutes (number): Ingestelde meldingsfrequentie in minuten.
  • minIntervalMinutes (number): Snelste frequentie die het huidige abonnement toestaat.
  • availableCadences (number[]): Frequenties die beschikbaar zijn in het huidige abonnement.

Voorbeeldverzoek

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

Opmerkingen

Is de gevraagde frequentie sneller dan het abonnement toestaat, dan zet RedReplier hem op minIntervalMinutes.

Fouten

  • 400 Bad Request: Ongeldige invoer, URL, UUID, enum, queryparameter of body.
  • 401 Unauthorized: Bearer-token ontbreekt of is ongeldig, of code: "token_issuer_lost_access" als de persoon die de API-sleutel heeft aangemaakt is gedeactiveerd of de workspace heeft verlaten.
  • 403 Forbidden: code: "subscription_required" als het abonnement van de workspace geen API-toegang bevat, code: "workspace_access_denied" als X-Workspace-Id een workspace noemt waar deze inloggegevens geen toegang toe hebben, of code: "permission_denied" als je rol in de workspace geen redreplier.write heeft (Admin en Editor hebben die wel).
  • 404 Not Found: De resource bestaat niet voor het account van het token.
  • 429 Too Many Requests: Rate limit overschreden. Wacht het aantal seconden uit Retry-After.
  • 500 Internal Server Error: Onverwachte serverfout.
Voorbeeldverzoek (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]
}