API Reference

Create a Questionnaire.

post
https://sandbox-api.monark-markets.com/primary/v1/questionnaire
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Payload describing the questionnaire to create.

Create Questionnaire allows the creation of a questionaire with the primary offerring.

string
required
length ≥ 1

Name of Questionnaire.

string
required
length ≥ 1

Title of Questionnaire.

createQuestions
array of objects
required
length ≥ 1

Questions to create with the questionnaire.

createQuestions*

Create Questionnaire Question.

string
required
length ≥ 1

Identifier for the question.

int32
required
> 0

Order sequence of the question within the Questionnaire.

string
enum
required

Question status, could be active or disabled. Questions can be set to disabled and new questions created if a Partners elects to edit one or more of the questions presented to their Investors.

Allowed:
string
required
length ≥ 1

Text of the question.

string | null
required

An explanation of the question presented within a Questionnaire. Helps the Investor understand the question being asked by providing additional context.

string
enum
required

Format of the question.

boolean

Whether the question is required to be answered.

options
array of strings | null

A list of potential answers associated with a question.

options
int32 | null

Optional minimum value for a scale question.

int32 | null

Optional maximum value for a scale question.

int32 | null

Optional step value for a scale question.

dependentOn
object | null

Defines a question dependency that partners can use to conditionally display a question based on another question's answer.

Responses

Updated 29 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 29 days ago