POST
/
v4
/
questions

Authorizations

x-api-key
string
headerrequired

Headers

x-selected-account-id
string | null

Body

application/json
type
enum<string>
required

The type of question

Available options:
categorical,
free_text,
rating,
number
title
string
required
prompt
string
required
account_id
string
required

The ID of the account that owns the given entity.

choices
object[]

List of choices for the question. Required for CATEGORICAL questions.

ratingOptions
object

Options for rating questions.

numberOptions
object

Options for number questions.

multi
boolean

Whether the question allows multiple answers.

dropdown
boolean

Whether the question is displayed as a dropdown in the UI.

required
boolean

[To be deprecated in favor of question set question_id_to_config] Whether the question is required.

conditions
object[]

Conditions for the question to be shown.

Response

200 - application/json
type
enum<string>
required

The type of question

Available options:
categorical,
free_text,
rating,
number
title
string
required
prompt
string
required
id
string
required

The unique identifier of the entity.

created_at
string
required

The date and time when the entity was created in ISO format.

account_id
string
required

The ID of the account that owns the given entity.

created_by_user_id
string
required

The user who originally created the entity.

choices
object[]

List of choices for the question. Required for CATEGORICAL questions.

ratingOptions
object

Options for rating questions.

numberOptions
object

Options for number questions.

multi
boolean

Whether the question allows multiple answers.

dropdown
boolean

Whether the question is displayed as a dropdown in the UI.

required
boolean

[To be deprecated in favor of question set question_id_to_config] Whether the question is required.

conditions
object[]

Conditions for the question to be shown.