UpsertAlertSettingsParams

  • alertsEnabled
    Type: boolean
    required

    Master opt-in toggle for this scan

  • leviathanId
    Type: integer
    required

    The scan to configure (== saved_scan.leviathan_id)

  • channels

    Per-scan channel DEVIATIONS from the account default. Send only the keys that differ; omit entirely to inherit the account's set. An absent key means inherit, not off (ADR-0098 §5).

    • email
      Type: boolean

      Email to a verified address on the account

    • inapp
      Type: boolean

      In-app toast while the app is foregrounded

    • push
      Type: boolean

      Remote push notification (app backgrounded/closed)

    • telegram
      Type: boolean

      Telegram message to a linked chat

    • whatsapp
      Type: boolean

      WhatsApp message to an opted-in number

  • cooldownMinutes
    Type: integer | null
    min:  
    0

    Minimum minutes between alerts (NULL => default)

  • minNewTickers
    Type: integer | null
    min:  
    1

    Only alert when this many new tickers appear (NULL => default)