Create classic quiz

post

https://mini-games.fansunitedapi.com/v1/classic-quizzes

Create classic quizzes for your users to interact with.

Authentication: Staff member's JWT.

Query Params

client_id

string

required

Client ID parameter.

key

string

required

Client API key

Body Params

title

string

required

length ≥ 1

Title of classic quiz

description

string

Description of classic quiz

type

string

Classic quiz type

images

object

Images of classic quiz

status

string

enum

required

Status of classic quiz

Allowed:

auth_requirement

string

enum

Define default authentication requirement

Allowed:

flags

array of strings

Flags in classic quiz

flags

time

int32

Time in seconds to answer each question

custom_fields

object

Custom fields in classic quiz

labels

object

Labels in classic quiz

rules

string

Rules in public classic quiz

ad_content

string

AD content in public classic quiz

language

string

This property contains the language key, e.g. fr, de, en-US, etc.

alternative_title

string

This property can store an alternative title for the Classic Quiz

questions

array of objects

required

length ≥ 1

Questions in classic quiz

questions*

question

string

required

length ≥ 1

The question itself

images

object

Images of the question

options

array of objects

required

length ≥ 2

Available options of question

options*

option

string

required

length ≥ 1

The option itself

correct

boolean

required

Is the provided option correct or incorrect

images

object

Images of the option

option

string

required

length ≥ 1

The option itself

correct

boolean

required

Is the provided option correct or incorrect

images

object

Images of the option

embed_code

string

A HTML code for the question.

explanation

string

Explanation for the question.

context

object

The context of classic quiz

branding

object

Branding configuration in classic quiz

branding_id

string

Reference id to the branding template for this game.

scored

boolean

Indicates whether users will receive points from their participation or not.

points

int32

Points for correctly answered questions on scored quizzes are added to the user profile. Points are not rewarded for quizzes that are not scored.

max_attempts

int32

Determines how many attempts each user can make.

array of objects

List of related games or templates

Responses

400

Bad request

401

Unauthorized

403

Forbidden

404

Resource not found

500

Internal server error

Language

Credentials

Bearer

jwt

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Create classic quizzes for your users to interact with. Authentication: Staff member's JWT.