Create a new questionnaire for a user to answer | Thymia

Create a questionnaire for a user to answer using a thymia activity.

Warning: Before using this endpoint, please contact thymia to configure the questionnaires you want your users to complete.

The response contains:

A link to a thymia activity that allows the user to complete the questionnaire.
The id of the questionnaire which can be used to retrieve results after the questionnaire has been completed.

Create a questionnaire for a user to answer using a thymia activity. > **Warning**: Before using this endpoint, please contact thymia to configure the questionnaires you want your users to complete. The response contains: * A link to a thymia activity that allows the user to complete the questionnaire. * The id of the questionnaire which can be used to retrieve results **after the questionnaire has been completed**.

Authentication

x-api-keystring

Your API Activation Key

Request

This endpoint expects an object.

userobjectRequired

questionnaireTypestringRequired

The type of questionnaire to create, using values agreed with thymia. Before calling, first contact thymia to configure your custom set of questionnaires.

Response

Details of questionnaire created, including a link to a thymia activity.

idstringformat: "uuid"

The id of the newly created questionnaire

activityLinkstring

A link to the thymia app, allowing users to answer the questionnaire as a thymia activity

1	curl -X POST /v1/questionnaires \
2	-H "x-api-key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"user": {
6	"userLabel": "user-12345"
7	},
8	"questionnaireType": "depression-assessment"
9	}'

Authentication

Request

Response

Errors