users

Create a test participant for a researcher

Changed on

Overview

Creates a test participant with the same details as the researcher and the supplied email. This participant will bypass any fraud checks and on-boarding steps.

Enabling the feature

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

Participant Limitations

  • The participant will be limited to take studies only in the workspaces associated to the researcher and where the feature is enabled.
  • The participant will not be able to cashout any balance earned from completing studies.

Usage

  • The API response contains the participant ID. This can be used in a custom allowlist or participant group to target the participant on studies. This enables the researcher to test the study set up end-to-end.
  • A randomly generated password is assigned to the participant account. We recommend that you request to reset the password, and use this new password to login to the participant account.
post/api/v1/researchers/participants/

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/researchers/participants/
  • Auth
    API key in header Authorization

Request body

emailstring email required
  • The email of the test participant.
  • This cannot be an email that has been registered with Prolific already.

Response

Created

participant_idstring objectId

The ID of the test participant

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-participant-for-researcher removed and replaced with users_CreateTestParticipantForResearcher