API ReferenceWorkspaces

Update a workspace

View as MarkdownOpen in Claude
Updates a workspace's details.

Authentication

Authorizationstring
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

workspace_idstringRequired
Workspace id

Request

This endpoint expects an object.
idstringRequired
Workspace id. It is created by Prolific.
titlestringRequired
Name of workspace
descriptionstringOptional
What is this workspace used for
ownerstringOptional
Workspace id. It is created by Prolific.
userslist of objectsOptional
Data for a user related to a workspace
projectslist of objectsOptional
Data for a project related to a workspace
walletstringOptional
Wallet tied to workspace
naivety_distribution_ratedouble or nullOptional0-1Deprecated
The rate at which the studies within this workspace are distributed.

Response

Updated workspace redirect link
idstring
Workspace id. It is created by Prolific.
titlestring
Name of workspace
descriptionstring or null
What is this workspace used for
ownerstring or null
Workspace id. It is created by Prolific.
userslist of objects or null
Data for a user related to a workspace
projectslist of objects or null
Data for a project related to a workspace
walletstring or null
Wallet tied to workspace
naivety_distribution_ratedouble or null0-1Deprecated
The rate at which the studies within this workspace are distributed.

Errors