PRprolific
projects

Update a project

Changed on

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}/

Request

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

Path parameters

project_idstring required

Project id

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.

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 update-project removed and replaced with projects_UpdateProject