Update a project | Prolific API

curl -X PATCH https://api.prolific.com/api/v1/projects/62fce6fff0a78eb4f3ebc09c/ \
     -H "Authorization: Token <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "title": "My updated project",
  "description": "This project is for..."
}'

{
  "id": "62fce6fff0a78eb4f3ebc09c",
  "title": "My updated project",
  "type": "PRIVATE",
  "description": "This project is for...",
  "owner": "60a42f4c693c29420793cb73",
  "public_details": null,
  "users": [
    {
      "id": "60a42f4c693c29420793cb73",
      "name": "Joe Soap",
      "email": "joe.soap@gmail.com",
      "roles": [
        "PROJECT_EDITOR"
      ]
    }
  ],
  "workspace": "60a42f4c693c29420793cb73",
  "naivety_distribution_rate": 0.5
}

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

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.

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.

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.

is_longitudinalboolean

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

longitudinalobject or null

Only present when is_longitudinal is true.

naivety_distribution_ratedouble or null0-1Deprecated

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

Errors

4XX

Client Request Error