Create a question
POST/v3/questions
Create a question
Request
- application/json
Body
Array [
]
Array [
]
Array [
Array [
]
]
Array [
Array [
]
]
Array [
]
Survey Id
Section Id
question
object
required
Question text
Question description
Possible values: [FileInput, TextInput, OpinionScale, MultiChoice, BipolarMatrix, CameraInput, Consent, ConstantSum, ContactForm, DateTime, Dropdown, EmailInput, GroupRating, Matrix, Message, NumberInput, PhoneNumber, RankOrder, Rating, Signature, Slider, URLInput, YesNo, GroupRank, AudioInput, PaymentQuestion, NPSFeedback, CESFeedback, CSATFeedback]
Type of question
Is response mandatory for this question?
Should the choices be randomized?
Possible values: Value must match regular expression /^[a-zA-Z0-9 ]*$/
Can users select multiple answers for the question?
choices
object[]
Choice text
Choice score
Should be set to true if individual choices has scores
To enable other option
To enable all of the above option. Works only if multipe_answers is set to true
To enable none of the above option
other_text
object
Other option text
Other option score
all_of_the_above_text
object
All of the above text
none_of_the_above_text
object
None of the above option option text
None of the above option option score
properties
object
data
object
label for min value
label for max value
label for mid value
Possible values: [3, 4, 5, 6, 7, 8, 9, 10, 11, 12]
Step value for opinion scale
Respondents can answer by voice. Only for text input type questions
To analyze the sentiment of the respondents. Only for text input type questions
To enable ranking in group rank question type
To randomize choices in group rank question
To allow choices to repeat in a same group in group rank question
Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]
Only for message question type in chat surveys
Possible values: [SINGLE_LINE, MULTI_LINE, UNLIMITED, EXACT, RANGE, DATETIME, DATE_ONLY, SLIDER, TEXT, DROP_DOWN, MULTIPLE_ANSWER, RATING, SINGLE_ANSWER, TEXT_INPUT]
Answer type for multiple choice, date time, constant sum and matrix questions.
Possible values: [INR, USD, EUR, GBP, AUD, CAD, CHF, NOK, SEK, DKK, MXN, NZD, BRL, SGD, RON, CZK]
Currency code is needed for payment question
Amount to be paid for payment question
Expression Id for payment
Variable Id for payment
discount
object
discount_coupons
object[]
Possible values: >= 1
Possible values: non-empty and <= 50 characters, Value must match regular expression /^[a-zA-Z0-9_]+$/
Coupon code
Possible values: [Amount, Percentage]
Discount type
Possible values: >= 1
Discount amount is required when discount_type is Amount
Possible values: >= 1 and <= 100
Discount percentage is required when discount_type is Percentage
Possible values: [RATING_STAR, RATING_CROWN, RATING_LIGHTNING, RATING_SMILEY, RATING_THUMBSUP, RATING_USER]
Icon type for rating
Possible values: >= 3 and <= 10
Rating scale. Should be between 1-5 for rating type question. Should be between 3-10 for group rating question.
Possible values: [smileySlider, lineSlider, trafficLightSlider, thermometerSlider, gaugeSlider]
Only allowed for slider type question
To show slider progress value
To show total for constant sum.
Defining total sum for constant sum.(total_sum must not be greater than 1000000)
Possible values: <= 200 characters
Consent text for consent question
To enable terms and conditions for consent question
Possible values: <= 10 characters
Symbol to be displayed for constant sum
Possible values: [PREFIX, SUFFIX]
Position of symbol for constant sum
Possible values: <= 10
Segments for slider question. Should be between 0-10 for constant sum. Should be between 0-5 for slider type question
Possible values: [0, 1, 2]
Decimal points for slider type question
To stack choices/sub questions vertically
Possible values: >= 1 and <= 5
Maximum number of files allowed for file input type question
To enable draw option for signature type question
To enable typing option for signature type question
To enable upload option for signature type question
Possible values: [MMDDYYYY, DDMMYYYY, YYYYMMDD]
Date format for datetime question
Possible values: [TWENTY_FOUR_HOUR, TWELVE_HOUR]
Time format for datetime question
Should the calendar be shown?
Yes text for yes or no question type
No text for yes or no question type
Possible values: [YES_NO_ICON_TICK_CROSS, YES_NO_ICON_THUMBS]
Icon for yes or no question
Possible values: [0, 1]
Starting value for opinion scale
Reverse scale for opinion scale
Possible values: [image, doc, video, audio]
Possible values: [CONTENT_WIDTH, FULL_WIDTH]
Table layout matrix and bipolar type questions
MinLimit is required for multiple choice question with RANGE answer type. Optional for constant sum, number input, slider, group rank.
MaxLimit is required for multiple choice question with RANGE answer type. Optional for constant sum, number input, slider, group rank.
Required for multiple choice question with Exact answer type
To include feedback by rating for Feedback question type
Promoter text for NPS feedback question type
Passive text for NPS feedback question type
Detractor text for NPS feedback question type
Low effort text for CES feedback question type
Neutral text for CES feedback question type
High effort text for CES feedback question type
Satisfied text for CSAT feedback question type
Dissatisfied text for CSAT feedback question type
To translate answers for feedback question type
column
object[]
Possible values: >= 1
Possible values: <= 200 characters
Column name for matrix, bipolar matrix
choices
object[]
Possible values: <= 500 characters
Required only for DROP_DOWN answer type in matrix question
row
object[]
Possible values: >= 1
Possible values: <= 200 characters
Sub question or row text
Right row text. Required only for bipolar matrix.
Only for questions in contact form. True by default
Possible values: [string, number, email, date, dropdown, PhoneNumber]
Sub question type for contact form. Required only for contact form.
choices
object[]
Possible values: <= 500 characters
Required only for DROP_DOWN answer type in contact form question.
display_logic
object
logics
object[]
Possible values: [and, or]
Default value: and
Possible values: [param]
Custom variable type
Possible values: [isPassed, isNotPassed, startsWith, endsWith, contains, equalsString, doesNotContain, notEqualTo, lessThanForParam, greaterThanForParam]
Condition type to check
Not required for comparators isPassed and isNotPassed
Responses
- default
Successful
- */*
- Schema
Schema
string