Create a question

post

https://api.mindstamp.com/api/v1/interactions/question/create

Create a new question for a specified video

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

video_id

string

required

The video_id or token of the video you want to add the interaction to

type

string

required

The type of question (either 'free', 'multiple', 'all', 'draw', 'number', 'date', 'video', 'voice', 'image', 'rating', 'select', 'likert', 'poll')

time

float

required

When the question should appear on the screen

prompt

string

required

answers

string

A semi-colon separated list of answer choices

actions

string

enum

A semi-colon separated list of actions when an answer is clicked (track, reply, message, jump, link, video, back, email, phone, clip, audio, download, article, view, none). Defaults to reply.

values

string

A semi-colon separated list of values associated with the actions

top

string

left

string

height

string

width

string

background_color

string

correct_color

string

incorrect_color

string

prompt_color

string

answer_color

string

Alias for answers_color.

answer

string

Singular alias for answers. Use a semi-colon separated list of answer choices.

answers_color

string

Text color for answer choices.

correct_answer

string

The answer value that should be treated as correct. Match the answer text exactly for choice questions.

transition

string

Question transition style.

question_answers

string

JSON array of answer objects. Each object can include text, click_action, click_value, click_time, second_action, second_value, second_time, variable, variable_value, and correct.

text_color

string

Prompt text color alias.

question_answers_color

string

Answer text color.

question_correct_color

string

Correct answer color.

question_incorrect_color

string

Incorrect answer color.

question_single_correct

string

Single correct answer value.

question_multi_correct

string

JSON array or semi-colon separated list of correct answer values.

question_transition

string

Question transition alias.

timer

integer

Question time limit in seconds.

question_use_custom_design

boolean

Use custom design for the question.

question_use_time_limit

boolean

Use the timer as a question time limit.

question_skippable

boolean

Allow the viewer to skip the question.

question_rewindable

boolean

Allow the viewer to rewind from the question.

question_rewind_time

float

Timestamp to rewind to.

question_use_hint

boolean

Show a question hint.

question_hint

string

Question hint text.

question_repeat_until_correct

boolean

Repeat the question until the viewer answers correctly.

question_read_prompt

boolean

Read the prompt aloud.

question_read_answers

boolean

Read the answer choices aloud.

question_voice_number

integer

Voice number for read-aloud question audio.

question_post_message

string

Message shown after the question.

question_allow_upload

boolean

Allow upload responses where supported.

question_has_correct_answer

boolean

Whether this question has one or more correct answers.

question_min_length

integer

Minimum answer length.

question_max_length

integer

Maximum answer length.

question_min_value

integer

Minimum numeric answer value.

question_max_value

integer

Maximum numeric answer value.

question_correct_action

string

enum

Action to run after a correct answer.

question_correct_value

string

Action value for a correct answer.

question_correct_arg

string

Action argument for a correct answer.

question_incorrect_action

string

enum

Action to run after an incorrect answer.

question_incorrect_value

string

Action value for an incorrect answer.

question_incorrect_arg

string

Action argument for an incorrect answer.

internal_label

string

Internal label for organization use.

hidden

boolean

Hide this question by default.

hide_mobile

boolean

Hide this question on mobile devices.

hide_desktop

boolean

Hide this question on desktop devices.

variable

string

Variable name to set from the question.

value

string

Variable value to set from the question.

is_conditional

boolean

Enable conditional display logic.

conditional_show

boolean

Show the question when the condition matches.

conditional_variable

string

Conditional variable name.

conditional_assertion

string

Conditional comparison operator.

conditional_value

string

Conditional comparison value.

conditional_operator

integer

Operator used when combining two conditions.

is_conditional_2

boolean

Enable a second conditional rule.

conditional_variable_2

string

Second conditional variable name.

conditional_assertion_2

string

Second conditional comparison operator.

conditional_value_2

string

Second conditional comparison value.

question_map_hubspot

boolean

Map question response to HubSpot.

hubspot_field

string

HubSpot field name.

hubspot_value

string

HubSpot field value.

clickfunnels_active

boolean

Enable ClickFunnels integration.

clickfunnels_tag

string

ClickFunnels tag.

clickfunnels_custom_attribute_name

string

ClickFunnels custom attribute name.

clickfunnels_custom_attribute_value

string

ClickFunnels custom attribute value.

Responses

401

Not Authorized

404

Not Found

422

Unprocessable Entity

500

Error

503

Rate Limit Exceeded

200Success

201Created