v4

OpenAPI 3.1.02026-07-31121440441.0 KB

projects

Update a project

Update a project's details. Public projects support partial updates to public_details. Once a public project has published studies, public_details.title can no longer be changed.

patch/api/v1/projects/{project_id}/

Path parameters

project_idstring required

Project 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>.

Request body

titlestring

Name of project

descriptionstring

What is this project used for

ownerstring

User id of the creator of the project.

positioninteger

Position of the project within a workspace.

hiddenboolean

Whether the project is hidden in workspace listings.

type'PRIVATE' | 'PUBLIC'

Project visibility type.

is_sequentialboolean

Whether the project is configured as sequential.

Response

Updated project redirect link

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.