Skip to navigation
API ReferenceProjects

Update a project

View as MarkdownOpen in Claude

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.

Authentication

AuthorizationToken

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

Path parameters

project_idstringRequired
Project id

Request

This endpoint expects an object.
titlestringOptional
Name of project
descriptionstringOptional
What is this project used for
ownerstringOptional
User id of the creator of the project.
positionintegerOptional
Position of the project within a workspace.
hiddenbooleanOptional
Whether the project is hidden in workspace listings.
typeenumOptional
Project visibility type.
Allowed values:
public_detailsobjectOptional

Public metadata for PUBLIC projects. Omit to leave unchanged.

is_sequentialbooleanOptional
Whether the project is configured as sequential.

Response

Updated project redirect link
idstring
Project id. It is created by Prolific.
titlestring
Name of project
typeenum
Project visibility type.
Allowed values:
descriptionstringOptional
What is this project used for
ownerstringOptional
User id of the creator of the project. It is created by Prolific.
public_detailsobject or nullOptional

Public metadata for PUBLIC projects. null for PRIVATE projects.

userslist of objectsOptional
Data for all users who have access to this project
workspacestringOptional
Id of the workspace this project is in. This is created by Prolific.
is_longitudinalbooleanOptional

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

longitudinalobject or nullOptional

Only present when is_longitudinal is true.

naivety_distribution_ratedouble or nullOptional0-1Deprecated
The rate at which the studies within this project are distributed.

Errors

4XX
Client Request Error