Create a new participant group within a workspace

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

The name of the participant group

workspace_idstringOptional

The id of the workspace to create the participant group in. Either a workspace or organisation ID must be specified.

organisation_idstringOptional

The id of the organisation to create the participant group in. Either a workspace or organisation ID must be specified.

descriptionstringOptional

A description of the participant group

participant_idslist of stringsOptional

The ids of participants to be initially added to the group

Response

Participant group created

descriptionstring or null

The user-provided description of the participant group

feeder_studieslist of objects or null

Details of all studies which are configured to modify the participants in this group through completion codes.

idstring or null

The id of the participant group

is_deletedboolean or null

Whether the participant group has been deleted

namestring or null

The name of the participant group

organisation_idstring or null

The id of the organisation the participant group belongs to. A participant group can only belong to either a workspace or an organisation.

participant_countinteger or null

The number of participants in the participant group

workspace_idstring or null

The id of the workspace the participant group belongs to. A participant group can only belong to either a workspace or an organisation.

project_idstring or nullDeprecated

The id of the project the participant group belongs to

1	import requests
2
3	url = "https://api.prolific.com/api/v1/participant-groups/"
4
5	payload = {
6	"name": "Group 1",
7	"workspace_id": "5e9b9c9b0f9c9a0001b1ca2f",
8	"description": "Participants with confirmed special dietary requirements.",
9	"participant_ids": ["5e9b9c9b0f9c9a0001b0b1f4", "5e9b9c9b0f9c9a0001b0b1f5", "5e9b9c9b0f9c9a0001b0b1f6"]
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": "My first participant group",
3	"feeder_studies": [
4	{
5	"id": "5e9b9c9b0f9c9a0001b0b1f4",
6	"name": "Study 1",
7	"internal_name": "My Study",
8	"status": "COMPLETED",
9	"feeder_completion_codes": [
10	{
11	"code": "AJVRH234",
12	"code_type": "COMPLETION_CODE",
13	"action": "ADD_TO_PARTICIPANT_GROUP"
14	}
15	]
16	}
17	],
18	"id": "5e9b9c9b0f9c9a0001b0b1f5",
19	"is_deleted": false,
20	"name": "Group 1",
21	"organisation_id": "5e9b9c9b0f9c9a0001b1ca2f",
22	"participant_count": 10,
23	"workspace_id": "5e9b9c9b0f9c9a0001b1ca2f",
24	"project_id": null
25	}

Authentication

Request

Response

Errors