Transition a mutually exclusive study collection

Transition a mutually exclusive study collection. This is used to:

Publish a study collection
Cancel publish a study collection
Schedule publish a study collection
- This can be done by setting the publish_at on the study collection at create or patch, then transitioning with the “SCHEDULE_PUBLISH” action
- Or optionally the publish_at can be provided directly in the body of the transition request

Transition a mutually exclusive study collection. This is used to: - Publish a study collection - Cancel publish a study collection - Schedule publish a study collection - This can be done by setting the publish_at on the study collection at create or patch, then transitioning with the "SCHEDULE_PUBLISH" action - Or optionally the publish_at can be provided directly in the body of the transition request

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

Path Parameters

idstringRequired

Request

This endpoint expects an object.

actionenumOptional

Allowed values:

publish_atstringOptional

Optional parameter for scheduling publish, indicating the datetime and timezone the study collection should be scheduled to be published at

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

1	import requests
2
3	url = "https://api.prolific.com/api/v1/study-collections/mutually-exclusive/id/transition/"
4
5	payload = { "action": "CANCEL_PUBLISH" }
6	headers = {
7	"Authorization": "<apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.post(url, json=payload, headers=headers)
12
13	print(response.json())

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

Authentication

Path Parameters

Request

Response

Errors