PRprolific
workspaces

Update a workspace

Changed on

Updates a workspace's details.

patch/api/v1/workspaces/{workspace_id}/

Request

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

Path parameters

workspace_idstring required

Workspace id

Request body

idstring required

Workspace id. It is created by Prolific.

titlestring required

Name of workspace

descriptionstring

What is this workspace used for

ownerstring

Workspace id. It is created by Prolific.

walletstring

Wallet tied to workspace

naivety_distribution_ratenumber double nullable

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

minimum_reward_per_hourinteger nullable

Minimum reward per hour for studies in this workspace, in hundredths of a penny or cent of the workspace's currency (for example, 300000 is 30.00 per hour). Applies in addition to Prolific's platform minimum. null means no workspace minimum is set, so only Prolific's minimum applies.

This is read-only: to enable a workspace-wide minimum reward per hour, contact Prolific support.

Response

Updated workspace redirect link

idstring required

Workspace id. It is created by Prolific.

titlestring required

Name of workspace

descriptionstring

What is this workspace used for

ownerstring

Workspace id. It is created by Prolific.

walletstring

Wallet tied to workspace

naivety_distribution_ratenumber double nullable

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

minimum_reward_per_hourinteger nullable

Minimum reward per hour for studies in this workspace, in hundredths of a penny or cent of the workspace's currency (for example, 300000 is 30.00 per hour). Applies in addition to Prolific's platform minimum. null means no workspace minimum is set, so only Prolific's minimum applies.

This is read-only: to enable a workspace-wide minimum reward per hour, contact Prolific support.

Changes

  • 36e3bb40c638Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • 6c9aa73fa51fRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API