API ReferenceStudy Collections

Update a mutually exclusive study collection

View as MarkdownOpen in Claude
Update a mutually exclusive study collection

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

idstringRequired

Request

This endpoint expects an object.
namestringOptional
Mutually exclusive study collection name
descriptionstringOptional
A description of the study collection
publish_atstring or nullOptional
Datetime and timezone the study collection should be scheduled to be published at
study_idslist of stringsOptional
List of study ids you wish to include in the collection. Note, this will overwrite the current list of studies in the collection

Response

Mutually exclusive study collection
descriptionstring or null
A description of the study collection
estimated_coststring or null
Estimated cost of the study collection
idstring or null
Mutually exclusive study collection id
namestring or null
Mutually exclusive study collection name
publish_atstring or null
Datetime and timezone the study collection should be scheduled to be published at
statusenum or null
Status of the study collection
study_idslist of strings or null
List of study ids you wish to include in the collection. Note, this will overwrite the current list of studies in the collection
total_coststring or null
Estimated cost of the study collection

Errors