---
title: "Update a workspace"
method: PATCH
path: "/api/v1/workspaces/{workspace_id}/"
tags: ["workspaces"]
---

# Update a workspace

`PATCH /api/v1/workspaces/{workspace_id}/`

Updates a workspace's details.

## Path parameters

- `workspace_id` string, required

## Headers

- `Authorization` string, required

## Request body

- Workspace
  - `id` string, required — Workspace id. It is created by Prolific.
  - `title` string, required — Name of workspace
  - `description` string — What is this workspace used for
  - `owner` string — Workspace id. It is created by Prolific.
  - `users` WorkspaceUser[] — Data for a user related to a workspace
    - `id` string, required — Id of user
    - `name` string — Name of user
    - `email` string — email of user
    - `roles` string[] — User roles in workspace
  - `projects` ProjectShort[] — Data for a project related to a workspace
    - `id` string, required — Project id. It is created by Prolific.
    - `title` string, required — Name of project
    - `description` string — What is this project used for
    - `owner` string — User id of the creator of the project. It is created by Prolific.
    - `type` 'PRIVATE' | 'PUBLIC', required — Project visibility type.
    - `public_details` PublicDetails
      - `status` 'ENABLED' | 'DISABLED' — Participant-facing publication status for a public project.
      - `title` string — Participant-facing title for the public project.
      - `short_description` string — Short participant-facing summary shown to participants for the public project.
      - `description` string — Additional participant-facing information shown to participants for the public project.
    - `users` WorkspaceUser[] — Data for all users who have access to this project
      - `id` string, required — Id of user
      - `name` string — Name of user
      - `email` string — email of user
      - `roles` string[] — User roles in workspace
    - `naivety_distribution_rate` number, double, nullable — The rate at which the studies within this project are distributed.
  - `wallet` string — Wallet tied to workspace
  - `naivety_distribution_rate` number, double, nullable — The rate at which the studies within this workspace are distributed.

## Response `200`

Updated workspace redirect link

- Workspace
  - `id` string, required — Workspace id. It is created by Prolific.
  - `title` string, required — Name of workspace
  - `description` string — What is this workspace used for
  - `owner` string — Workspace id. It is created by Prolific.
  - `users` WorkspaceUser[] — Data for a user related to a workspace
    - `id` string, required — Id of user
    - `name` string — Name of user
    - `email` string — email of user
    - `roles` string[] — User roles in workspace
  - `projects` ProjectShort[] — Data for a project related to a workspace
    - `id` string, required — Project id. It is created by Prolific.
    - `title` string, required — Name of project
    - `description` string — What is this project used for
    - `owner` string — User id of the creator of the project. It is created by Prolific.
    - `type` 'PRIVATE' | 'PUBLIC', required — Project visibility type.
    - `public_details` PublicDetails
      - `status` 'ENABLED' | 'DISABLED' — Participant-facing publication status for a public project.
      - `title` string — Participant-facing title for the public project.
      - `short_description` string — Short participant-facing summary shown to participants for the public project.
      - `description` string — Additional participant-facing information shown to participants for the public project.
    - `users` WorkspaceUser[] — Data for all users who have access to this project
      - `id` string, required — Id of user
      - `name` string — Name of user
      - `email` string — email of user
      - `roles` string[] — User roles in workspace
    - `naivety_distribution_rate` number, double, nullable — The rate at which the studies within this project are distributed.
  - `wallet` string — Wallet tied to workspace
  - `naivety_distribution_rate` number, double, nullable — The rate at which the studies within this workspace are distributed.

## Other responses

- `400` — Error

---

[API](https://skmtc.net/prolific/apis/api-reference.md) · [All operations](https://skmtc.net/prolific/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/prolific/api-reference/versions/dc6f073a9827/schema)