Skip to content

Forfeit quiz attempt

Gives up a quiz: the open attempt, or the attempts left, after which no attempt can be started.

Needs the quiz:write scope.

Call

  • Tool: forfeit_quiz
  • Scope: quiz:write
  • Writes, and may change or remove what is there.
  • Acts on a store.

Arguments

Name Type Required Description
product object Yes
quiz object Yes
preview string No 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, any quiz it does not open is not_found preview.
entry object Yes
{
  "type": "object",
  "properties": {
    "product": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "id"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "slug": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "slug"
          ],
          "additionalProperties": false
        }
      ]
    },
    "quiz": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    },
    "preview": {
      "description": "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, any quiz it does not open is `not_found` `preview`.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "entry": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "product",
    "quiz",
    "entry"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
attempt object Yes
certificate object or null Yes
certificates array of object Yes

The answer’s full shape is on its API reference page.

Type to search…

↑↓ navigate↵ selectEsc close