Skip to content
Navigation

Turns notification types on or off, for the notifications list and browser push alike.

PATCH
https://api.sherpo.io/customer/v1/stores/{store}/notification_settings

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    A hostname of the store.

Request body JSON required

  • types
    object
    required

    Each type to turn on (true) or off (false); a type left out keeps its setting.

    • portfolio_trade
      optional
      boolean
    • new_lesson
      optional
      boolean
    • new_episode
      optional
      boolean
    • new_post
      optional
      boolean
    • new_file
      optional
      boolean
    • new_product
      optional
      boolean
    • new_discount
      optional
      boolean
    • event_reminder
      optional
      boolean
    • event_follow_up
      optional
      boolean

Returns

200

Turns notification types on or off, for the notifications list and browser push alike.

JSON
  • types
    array of
    object
    required
    • type
      string
      required
    • enabled
      boolean
      required
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • detail
    string
    required
  • code
    optional
    string
  • context
    optional
    object
  • reached_core
    optional
    boolean
  • core_answer
    optional
    string

Type to search…

↑↓ navigate↵ selectEsc close