studies

Create a test study

Changed on

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

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/studies/{id}/test-study
  • Auth
    API key in header Authorization

Path parameters

idstring required

Study id

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.

Changes

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API

    • info

      api operation id create-test-study removed and replaced with studies_CreateTestStudy