Skip to main content
POST
Create SurveyQuestion
A SurveyQuestion defines a single question within a survey, including its type (text, boolean, long text, date, dropdown, or binary), label, and display order.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the SurveyQuestion-Create role.

Enums

Request Body

Required Fields

integer
required
ID of the survey linked to this record.
string
required
The text value for this survey question.
string
required
Free-text description of this survey question.
integer
required
The display order value for this survey question.
integer
required
The question type value for this survey question.

Optional Fields

string
The available options value for this survey question.
boolean
Whether this survey question is currently active.
boolean
Whether allow multiple options is enabled.

Code Examples

Response

200

integer
HTTP status code. 200 on success.
string
A human-readable message confirming the creation.
object
Contains the Id of the newly created record.
boolean
true if the surveyquestion was created successfully.
array
null on success.
Example Response

400

string
A summary of the validation error(s), in the format PropertyName: error message.
any
null on validation failure.
object[]
Array of validation errors.
boolean
false when the request fails validation.
Example Response