Skip to content
Navigation

Marks the named notifications read, or every unread one when none is named.

POST
https://api.sherpo.io/customer/v1/stores/{store}/notifications/read

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    A hostname of the store.

Request body JSON optional

  • ids
    optional
    array of
    string

    The notifications to mark read, each once; left out, every unread one is.

    maxLength: 64 · minLength: 1

Returns

200

Marks the named notifications read, or every unread one when none is named.

JSON
  • marked
    number
    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