Update quiz

Publishes/unpublishes using isActive. Metadata/settings can change while published. Separate unpublish is required before add/update/delete/replacement/reorder or mode changes. Publishing is independent per quiz.

Requires a community API key with quizzes permission; personal keys are rejected. Tenant comes from authentication. Unknown/system-owned body fields are rejected. JSON UTF-8 bodies are limited to 1 MiB. All responses use Cache-Control: no-store. Question mutations require a previous successful separate PATCH {"isActive":false}. Concurrent publication/configuration changes return 409 QUIZ_CONFLICT; fetch current detail before retrying.

PATCH /apis/v1/quizzes/{quizId}
Path quizId: required 24 hex characters; example 507f1f77bcf86cd799439011.

JSON parameters (all optional; at least one required): name, description, timezone, viewPermission {roles,users}, useServerTheme, customThemes, darkTheme, lightTheme, isActive, configuration. Configuration fields: quizMode, questions (full ordered replacement; max 500), settings, startScreen, endScreen. Settings/screens merge individual fields; arrays replace completely. See Create quiz for field constraints; question ids must remain stable.

Published quizzes reject ANY configuration.questions property, including unchanged arrays or isActive:false in the same request. Unpublish first in a separate successful request. Published metadata/settings changes are allowed.

Example — Publish:

{
  "isActive": true
}

Example — Unpublish first:

{
  "isActive": false
}

Example — Update settings:

{
  "configuration": {
    "settings": {
      "numberOfAttempts": 3
    }
  }
}

Example — Replace or reorder draft questions:

{
  "configuration": {
    "questions": [
      {
        "id": "q2",
        "type": "multi_select",
        "question": "Select all correct options",
        "options": [
          {
            "id": "a",
            "label": "A",
            "value": "A"
          },
          {
            "id": "b",
            "label": "B",
            "value": "B"
          }
        ],
        "correctAnswer": [
          "a",
          "b"
        ]
      },
      {
        "id": "q1",
        "type": "single_select",
        "question": "Which option is correct?",
        "options": [
          {
            "id": "a",
            "label": "A",
            "value": "A"
          },
          {
            "id": "b",
            "label": "B",
            "value": "B"
          }
        ],
        "correctAnswer": "a"
      }
    ]
  }
}

200 returns the complete updated quiz. Errors: 400 invalid configuration, 401 auth, 403 permission, 404 quiz not found, 409 QUIZ_PUBLISHED or QUIZ_CONFLICT, 413 body limit, 415 content type, 429 configured limit, 500 safe failure.

Audience: publishing requires at least one community role or user in viewPermission. Empty arrays deny user access and are allowed only while unpublished. A published quiz cannot have its viewers cleared; unpublish first. Select the community @all role for public visibility.

curl --location --request PATCH 'https://sgtr-integration.returning.ai/apis/v1/quizzes/507f1f77bcf86cd799439011' \ --header 'Authorization: <api-key>' \ --header 'Content-Type: application/json' \ --data '{"isActive":false}'

{ "meta": { "status": "success", "statusCode": 200, "requestId": "req_example" }, "message": "Quiz updated success.", "data": { "_id": "507f1f77bcf86cd799439011", "serverId": "507f191e810c19729de860ea", "type": "quiz", "name": "Product knowledge", "description": "", "timezone": "UTC", "isActive": false, "viewPermission": { "roles": [], "users": [] }, "useServerTheme": true, "customThemes": [], "configuration": { "quizMode": "knowledge", "startScreen": { "title": "Start Quiz", "description": "", "startButtonText": "Start the Quiz" }, "endScreen": { "title": "You have completed this quiz.", "description": "", "completeButtonText": "Done", "reAttemptButtonText": "Try Again", "showUserScore": true }, "settings": { "showQuizProgress": false, "backNavigation": false, "questionSkips": false, "numberOfAttempts": 1, "pointsPerQuestion": 1, "answerConfiguration": { "mode": "score_only" }, "showUserScore": true, "passingMarkEnabled": true, "passingPercentage": 50 }, "questions": [ { "id": "q1", "type": "single_select", "question": "Which option is correct?", "options": [ { "id": "a", "label": "A", "value": "A" }, { "id": "b", "label": "B", "value": "B" } ], "correctAnswer": "a" } ] }, "createdAt": "2026-10-03T00:00:00.000Z", "updatedAt": "2026-10-03T00:00:00.000Z" } }

Request

Responses