Alerts

Turn email alerts on or off and set the cadence

A cadence faster than the plan allows is clamped to the plan floor.

put/alert-settings

Request

  • Base URL: https://ai.redreplier.com/ai-app/api/v1
  • URL: https://ai.redreplier.com/ai-app/api/v1/alert-settings
  • Auth: HTTP bearer

Headers

X-Workspace-Idstring

The workspace to act in, for OAuth sign-ins that reach several workspaces. Take the id from GET /workspaces. Without it the call lands in the default workspace. A workspace the caller cannot reach answers 403 with code: workspace_access_denied. An API key belongs to one workspace: send its own id or leave the header out

Request body

enabledboolean required
cadenceMinutesinteger

Clamped up to the plan floor when it is too fast.

Response

Alert settings

enabledboolean required
cadenceMinutesinteger required
minIntervalMinutesinteger

Fastest cadence this plan allows.

availableCadencesinteger[]

Selectable cadences, in minutes.

Changes

No recorded changes to this operation across all 1 revision of this API.