Update a workspace | Prolific API

import requests
url = "https://api.prolific.com/api/v1/workspaces/workspace_id/"
payload = {
    "id": "63722982f9cc073ecc730f6b",
    "title": "My new workspace"
}
headers = {
    "Authorization": "Token <token>",
    "Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())

{
  "id": "62fce6fff0a78eb4f3ebc09c",
  "title": "My workspace",
  "description": "This workspace does...",
  "owner": "60a42f4c693c29420793cb73",
  "users": [
    {
      "id": "60a42f4c693c29420793cb73",
      "name": "Joe Soap",
      "email": "joe.soap@gmail.com",
      "roles": [
        "WORKSPACE_ADMIN"
      ]
    }
  ],
  "projects": [
    {
      "id": "60a42f4c693c29420793cb73",
      "title": "string"
    }
  ],
  "wallet": "61a65c06b084910b3f0c00d6"
}

Updates a workspace's details.

Authentication

AuthorizationToken

Header authentication of the form Token <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.

Authentication

Path parameters

Request

Response

Errors