Skip to content
Navigation

Saves the answers given so far to the open attempt, replacing those saved before, so it resumes on any device.

POST
https://api.sherpo.io/customer/v1/stores/{store}/products/{product}/attempts/{attempt}/save

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    A hostname of the store.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1
  • attempt
    string
    required
    minLength: 1

Request body JSON required

  • answers
    map of
    any of
    required

    Each text answer at most 4000 characters; replaces the answers saved before.

  • preview
    optional
    string

    A token a seller made for the quiz's product's page, which opens the quiz of a published entry of the product unpublished, or for the quiz's entry, which opens it unpublished too, gated as ever; with it, a sitting on any quiz it does not open is not_found preview.

    maxLength: 128 · minLength: 1

Returns

200

Saves the answers given so far to the open attempt, replacing those saved before, so it resumes on any device.

JSON
  • attempt
    object
    required
    • id
      string
      required
    • product_id
      string
      required
    • quiz_id
      string
      required
    • entry_id
      string
      required
    • attempt
      number
      required
    • status
      string
      required
    • score
      required

      One of the following:

      • number
      • null
    • correct
      required

      One of the following:

      • number
      • null
    • started_at
      string
      required
    • finished_at
      required

      One of the following:

      • string
      • null
    • access
      string
      required
  • answers
    map of
    any of
    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