Create a mutually exclusive study collection.

Studies and study collections must be created separately and then added to the mutually exclusive study collection.
Both the studies and the study collection must be in the same project.
You can only add draft studies to a mutually exclusive study collection.
Adding studies which are already in one study collection to another study collection will remove the study from the original study collection.

Create a mutually exclusive study collection. - Studies and study collections must be created separately and then added to the mutually exclusive study collection. - Both the studies and the study collection must be in the same project. - You can only add draft studies to a mutually exclusive study collection. - Adding studies which are already in one study collection to another study collection will remove the study from the original 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>.

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>`.

Request

This endpoint expects an object.

namestringRequired

Mutually exclusive study collection name

descriptionstringRequired

A description of the study collection

project_idstringRequired

Project id

study_idslist of stringsOptional

List of study ids you wish to include in the collection

publish_atstring or nullOptional

Datetime and timezone the study collection should be scheduled to be published at

Response

Created

descriptionstring or null

A description 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

1	import requests
2
3	url = "https://api.prolific.com/api/v1/study-collections/mutually-exclusive/"
4
5	payload = {
6	"name": "My Mutually Exclusive Study Collection",
7	"description": "This is a description of my mutually exclusive study collection",
8	"project_id": "65786062db3b35bcbeb07bcc",
9	"study_ids": ["5f7b9a7b5f7b9a7b5f7b9a7b", "5f7b9a7b5f7b9a7b5f7b9a6b"]
10	}
11	headers = {
12	"Authorization": "<apiKey>",
13	"Content-Type": "application/json"
14	}
15
16	response = requests.post(url, json=payload, headers=headers)
17
18	print(response.json())

1	{
2	"description": "This is a description of my mutually exclusive study collection",
3	"id": "6527ffc7fcc2e63a7a555488",
4	"name": "My Mutually Exclusive Study Collection",
5	"publish_at": "2050-02-28T13:45:00 Europe/London",
6	"status": "ACTIVE",
7	"study_ids": [
8	"5f7b9a7b5f7b9a7b5f7b9a7b"
9	]
10	}

Authentication

Request

Response

Errors