Skip to content
Navigation

Update digest preferences

PUT
https://api.sureshake.com/v2/notifications/preferences/digest

Request body JSON

  • emailEnabled
    optional
    boolean
  • inAppEnabled
    optional
    boolean
  • emailDigestFrequency
    optional
    immediate
    or
    daily
    or
    weekly
    or
    none
  • timezone
    optional
    string
    or null
    maxLength: 100 · minLength: 1
  • digestSendTimeLocal
    optional
    string
    or null
    pattern: ^([01]\d|2[0-3]):[0-5]\d$
  • digestSendDay
    optional
    integer
    or null
    maximum: 6 · minimum: 0

Returns

200

Default Response

JSON
  • data
    object
    required
    • emailEnabled
      boolean
      required
    • inAppEnabled
      boolean
      required
    • emailDigestFrequency
      immediate
      or
      daily
      or
      weekly
      or
      none
      required
    • timezone
      string
      or null
      required
    • digestSendTimeLocal
      string
      or null
      required
    • digestSendDay
      integer
      or null
      required
      maximum: 6 · minimum: 0
    • deliveryChannels
      array of
      object
      required
      • key
        email
        or
        in_app
        or
        slack
        or
        telegram
        required
      • availability
        live
        or
        planned
        required
      • enabled
        boolean
        required
      • configurable
        boolean
        required
  • meta
    optional
    object
    • timestamp
      string
      required
      format: date-time

400

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

401

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

500

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

Type to search…

↑↓ navigate↵ selectEsc close