Hooks

Update a video hook

patch/api/v1/quizzes/{id}/hooks

Request

  • Base URL: https://www.quiz.video
  • URL: https://www.quiz.video/api/v1/quizzes/{id}/hooks
  • 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

hookIdinteger required
hookType'engagement' | 'reminder' | 'conclusion' | 'custom'
positionType'after_question' | 'time_based' | 'start' | 'end'
positionValueinteger
titlestring
contentstring
emojistring
animationStyle'fade' | 'bounce' | 'slide' | 'zoom'
displayDurationinteger
ttsEnabledboolean
ttsTextstring
themeColorstring
backgroundColorstring
fontSizeinteger
enabledboolean
introTemplatestring

Response

Successful response

Changes

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