API referencePUT

Update alert settings

Enable or disable email alerts and set their cadence.

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

Enable or disable email alerts and set their cadence.

Bearer Token (RedReplier API token)

Parameters

This endpoint does not take path or query parameters.

Request body

  • enabled (boolean, required): Turn email alerts on or off.
  • cadenceMinutes (integer, optional): Desired cadence. Common allowed values are 60, 240, 720, and 1440; the response includes the values currently available to the plan.

Response

Returns alert settings for the token account.

  • enabled (boolean): Whether email alerts are enabled.
  • cadenceMinutes (number): Configured alert cadence in minutes.
  • minIntervalMinutes (number): Fastest cadence allowed by the current plan.
  • availableCadences (number[]): Cadence values available to the current plan.

Notes

If the requested cadence is faster than the plan allows, RedReplier clamps it to minIntervalMinutes.

Errors

  • 400 Bad Request: Invalid input, URL, UUID, enum, query parameter, or body.
  • 401 Unauthorized: Missing or invalid Bearer token.
  • 404 Not Found: The resource does not exist for the token account.
  • 500 Internal Server Error: Unexpected server error.
Example request (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]
}