1. Quizzes
Returning.AI
  • Getting Started
  • Bulk Operations
    • Bulk user updates
    • List bulk update jobs
      GET
    • Get bulk update job status
      GET
    • Get bulk update job details
      GET
    • Bulk update users from CSV
      POST
    • Bulk update premium currency from CSV
      POST
  • Chart Analysis
    • Create Analysis
      POST
    • Get Analysis
      GET
    • Update Analysis
      PATCH
    • Delete Analysis
      DELETE
    • List Analyses
      GET
    • Append Drawings
      POST
  • Rewards & Redemptions
    • Redemption lifecycle
    • Store catalog to redemptions
    • Update redemption order status or refund
    • List redemption orders by user email
    • List redemption statuses
    • Get redemption status by ID
    • List redemption orders by community
    • Create redemption order status
    • Get redemption order status history
    • List redemption orders by custom-field identifier
  • Gamification
    • Leaderboards
      • Leaderboards
      • List leaderboards with pagination
      • Create a new leaderboard
      • Update an existing leaderboard
      • Get a single leaderboard by ID
      • Delete a leaderboard
    • Streaks & Mini Games
      • Mini-game State and History
      • List user streak logs
      • List mini-game logs by user email
      • Get current mini-game and streak state
      • Update user spin-wheel information
    • Referral
      • Referral Program Integration
      • Get referral programs
      • Get user's referral summary
    • Rolling Data
    • Match Predictions
      • Create match prediction
      • List match predictions
      • Get match prediction
      • Patch match prediction
      • Publish match prediction
      • Settle match prediction
      • Get settlement results
      • Void match prediction
      • Bulk update match predictions
      • Get bulk job status
      • Get bulk job results
    • Loyalty Points
      • Create loyalty points export
      • Get loyalty points export status
      • Get loyalty points export download link
    • Quizzes
      • Create quiz
        POST
      • List quizzes
        GET
      • Get quiz
        GET
      • Update quiz
        PATCH
      • Delete quiz
        DELETE
      • Add quiz question
        POST
      • Update quiz question
        PATCH
      • Delete quiz question
        DELETE
    • Get tier configuration
      GET
    • Get daily user XP and coin changes
      POST
    • Search user gamification logs
      POST
    • Get user activity stats
      POST
  • Messaging
    • Agent messaging workflow
    • Get Messages
    • Send Message
    • Reply Message
    • React Message
    • Upload message images
  • Users
    • User directory and provisioning
    • Get Users with Filters
    • Create New User
    • Get User Data
    • Manage User Account
    • Get User Milestones
    • Update User Data, Identifier, And Roles
  • Channels
    • Iframe
    • List integration channels
  • Events
    • Outgoing webhooks
      • Encryption
      • User Joins Server
      • User Visits server
      • New Message Posted Anywhere
      • New Message Posted To channel
      • Purchased Store Item
    • Incoming webhooks
      • API Keys & Encryption
      • Send message into channels
      • Update Custom User Fields
      • Update In-game currency
  • Widgets
    • Authenticated Widgets
    • Public widgets
    • Channels
    • Leaderboard
    • Milestone
    • Socials
    • Store
  • Community Analytics
    • Get Loyalty Overview
    • Get Phone Verification Contacts
  • Store
    • Store journey
    • Store catalog
    • Purchase History
      • Archive or restore an order
      • Update redemption instructions or voucher details
    • Categories
      • List Store categories
      • Create Store category
      • Get Store category by ID
      • Update Store category
      • Delete Store category
    • Products
      • List products
      • Create products in bulk
      • Create product with vouchers
      • Update products in bulk
      • Read product
      • Update product and append vouchers
      • Delete product
    • Redemption-transaction
      • Get redemption transaction detail
    • Get Store configuration
    • Update Store configuration
  • Community
    • Community directory and appearance
    • Appearance
      • Update community theme colors
      • Update community bot profile
      • Update community URL metadata
      • Update community name and URL
    • Community Users
      • Get community users
      • Get user
    • Create community
  • User Fields
    • User field definitions and history
    • User Field History
      • List Community User-Field History
      • List One Field Across Users
      • List One User Across Fields
      • List One User's One Field
      • Update A User Field Value
      • Deprecated Field-First History Write
      • Deprecated Field-First History Read
    • Create A User Field Definition
    • Get A User Field Definition
    • Update A User Field Definition
    • Delete A User Field Definition
    • List User Field Definitions
  • API Keys
    • API key lifecycle
    • Community API Keys
      • Create API key
      • Read API keys
      • Delete API key
      • Update API key
    • User API Keys
      • List user API keys
      • Create user API key
      • Update user API key
      • Delete user API key
      • Get current API key information
  • Legacy
    • Servers
      • Create server
      • List servers
      • Update server metadata
    • Bulk Operations
      • Bulk import users from CSV
    • Authentication
      • Register user with password
      • Verify user email
      • Log in user with password
      • Secure Auth
    • Badges
      • List badges
      • Create badge
      • Update badge
      • Delete badge
      • Remove badge from user
      • Award badge to user
    • Messaging
    • Roles & Permissions
      • List server roles
      • Create role
      • Update role
      • Delete role
      • List user roles
      • Add role to user
      • Remove role from user
    • Users
      • Get user
      • Upload user avatar
    • Channels
      • Create channel
      • Update channel
      • Delete channel
    • API Keys
      • List integration API keys
      • Create integration API key
      • Delete integration API key
      • Update integration API key
  • Community Logs
    • Retrieve and export community logs
  1. Quizzes

Add quiz question

Developing
POST
https://sgtr-integration.returning.ai/apis/v1/quizzes/{quizId}/questions
Requires an inactive draft. Returns the whole updated 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.
POST /apis/v1/quizzes/{quizId}/questions
Path quizId: required 24 hex characters; example 507f1f77bcf86cd799439011.
Required JSON: type (single_select|multi_select|score), question (1–500 characters). Optional id (stable string ≤128; generated UUID if omitted), description (≤20000), images (≤20 URLs), options (≤100 {id,label,value}; unique ids), correctAnswer, points/timeLimit (nonnegative), teamA/teamB. Choice questions require at least one option. single_select correctAnswer is one option id; multi_select is an array of distinct option ids. Knowledge requires a nonempty valid answer. Universal choices may omit/null the answer. Score requires Universal mode, both nonempty team names, no options, and null or {teamA:integer>=0,teamB:integer>=0}. Score and choice questions cannot mix. Maximum 500 questions.
Example — Multi-select choice:
{
  "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"
  ]
}
Example — Universal-only score:
{
  "id": "score1",
  "type": "score",
  "question": "Predict the result",
  "teamA": "Team A",
  "teamB": "Team B",
  "options": [],
  "correctAnswer": null
}
201 returns the whole updated quiz, including its ordered questions. Unpublish first through a separate quiz PATCH {"isActive":false}. Errors: 400 validation, 401 auth, 403 permission, 404 quiz missing, 409 QUIZ_PUBLISHED/QUIZ_CONFLICT, 413 body limit, 415 content type, 429 rate limit, 500 safe failure.

Request

Authorization
API Key
Add parameter in header
Authorization
Example:
Authorization: ********************
or
Path Params

Body Params application/jsonRequired

Examples

Responses

🟢201Success
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://sgtr-integration.returning.ai/apis/v1/quizzes/507f1f77bcf86cd799439011/questions' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
  "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"
  ]
}'
Response Response Example
{
  "meta": {
    "status": "success",
    "statusCode": 201,
    "requestId": "req_example"
  },
  "message": "Quiz question added 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"
        },
        {
          "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"
          ]
        }
      ]
    },
    "createdAt": "2026-10-03T00:00:00.000Z",
    "updatedAt": "2026-10-03T00:00:00.000Z"
  }
}
Modified at 2026-10-03 02:02:46
Previous
Delete quiz
Next
Update quiz question
Built with