Create a new participant group within a workspace

import requests
url = "https://api.prolific.com/api/v1/participant-groups/"
payload = {
    "name": "Group 1",
    "workspace_id": "5e9b9c9b0f9c9a0001b1ca2f",
    "description": "Participants with confirmed special dietary requirements.",
    "participant_ids": ["5e9b9c9b0f9c9a0001b0b1f4", "5e9b9c9b0f9c9a0001b0b1f5", "5e9b9c9b0f9c9a0001b0b1f6"]
}
headers = {
    "Authorization": "Token <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "description": "My first participant group",
  "feeder_studies": [
    {
      "id": "5e9b9c9b0f9c9a0001b0b1f4",
      "name": "Study 1",
      "internal_name": "My Study",
      "status": "COMPLETED",
      "feeder_completion_codes": [
        {
          "code": "AJVRH234",
          "code_type": "COMPLETION_CODE",
          "action": "ADD_TO_PARTICIPANT_GROUP"
        }
      ]
    }
  ],
  "id": "5e9b9c9b0f9c9a0001b0b1f5",
  "is_deleted": false,
  "name": "Group 1",
  "organisation_id": "5e9b9c9b0f9c9a0001b1ca2f",
  "participant_count": 10,
  "workspace_id": "5e9b9c9b0f9c9a0001b1ca2f",
  "project_id": null
}

Authentication

AuthorizationToken

Header authentication of the form Token <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 nullRead-only

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 nullRead-only

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 nullRead-only

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

Authentication

Request

Response

Errors