Quizzes

Update quiz metadata

patch/api/v1/quizzes/{id}

Request

  • Base URL: https://www.quiz.video
  • URL: https://www.quiz.video/api/v1/quizzes/{id}
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://www.quiz.video/api/auth/oauth2/authorize, token URL https://www.quiz.video/api/auth/oauth2/token, scopes: api:read)
    • OpenID Connect (https://www.quiz.video/.well-known/openid-configuration, scopes: api:read)

Path parameters

idstring required

Quiz ID

Request body

titlestring
descriptionstring
formatstring
quizTypestring
isPublishedboolean
backgroundMusicIdinteger nullable

Omit to leave unchanged; set null for silent.

musicVolumenumber
templatestring
countdownSecondsinteger
themeDescriptionstring

Natural-language prompt used to generate and save a custom visual theme.

Response

Successful response

Example response

{
  "data": {
    "format": "tiktok",
    "quizType": "multiple_choice"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.