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

Header authentication of the form Token <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:
descriptionstring
What is this project used for
ownerstring
User id of the creator of the project. It is created by Prolific.
public_detailsobject or null

Public metadata for PUBLIC projects. null for PRIVATE projects.

userslist of objects
Data for all users who have access to this project
workspacestring
Id of the workspace this project is in. This is created by Prolific.
naivety_distribution_ratedouble or null0-1Deprecated
The rate at which the studies within this project are distributed.

Errors

4XX
Client Request Error