PRprolific
projects

Create a project

Changed on

Creates a new project within the workspace. When this project is created, it adds the user as a Project Editor. Set type to PUBLIC to create a public project.

post/api/v1/workspaces/{workspace_id}/projects/

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/workspaces/{workspace_id}/projects/
  • Auth
    API key in header Authorization

Path parameters

workspace_idstring required

Workspace id

Request body

titlestring required

Name of project

descriptionstring

What is this project used for

type'PRIVATE' | 'PUBLIC'

Project visibility type.

naivety_distribution_ratenumber double nullable

Control the balance between speed of your studies and the naivety of the participants.

If not defined, by default Prolific calculates the best rate for most studies taking into account the filters and the total_available_places needed for this study.

Use 0 if your priority is speed. When this property is set to 0 all eligible participants will have access to your study at the same time, without any prioritization.

You can also set this at a workspace and study level.

is_longitudinalboolean

Whether this is a longitudinal (multi-wave) project. Defaults to false. Longitudinal projects must be PUBLIC. Omit type entirely and it will default to PUBLIC automatically when this is true, rather than falling through to type's own PRIVATE default.

Response

Successfully created project.

idstring required

Project id. It is created by Prolific.

titlestring required

Name of project

descriptionstring

What is this project used for

ownerstring

User id of the creator of the project. It is created by Prolific.

type'PRIVATE' | 'PUBLIC' required

Project visibility type.

workspacestring

Id of the workspace this project is in. This is created by Prolific.

naivety_distribution_ratenumber double nullable

The rate at which the studies within this project are distributed.

is_longitudinalboolean

Whether this is a longitudinal (multi-wave) project.

Changes

  • 6c9aa73fa51fRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API

  • e9e1e322aacbRevision changes
    • info

      api operation id create-project removed and replaced with projects_CreateProject