Sign in

v4

latestOpenAPI 3.1.02026-07-31121440441.0 KB
studies

Create a test study

Overview

  • Make sure atleast one test participant is created and exists against the user before hitting this endpoint.
    • To create test participant: POST /api/v1/researchers/participants/
  • Create and publish a test study from a draft study to all the test participants associated with the workspace.
  • This will allow a data collector to test the study as a participant.

Prerequisites

✅ Required:

  • At least one active test participant (created via POST /api/v1/researchers/participants/)
  • Study must be in draft status
  • Feature enabled for your workspace (contact support if unavailable)

Enabling the feature

This endpoint is only enabled for select workspaces and will need enabling before the endpoint can be used.

post/api/v1/studies/{id}/test-study

Path parameters

idstring required

Study id

Headers

Authorizationstring required

The Prolific API uses API token to authenticate requests. You can create an API token directly from your settings.

Your API token does not have an expiry date and carries full permission, so be sure to keep them secure.

If your token is leaked, delete it and create a new one directly in the app.

In your requests add Authorization header with the value Token <your token>.

Response

Found

study_idstring objectId

The ID of the study that was created for the test.

study_urlstring uri

The URL of the study that was created for the test.