Update a participant group

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Path parameters

idstringRequired

The id of the participant group

Request

This endpoint expects an object.

namestringOptional

The name of the participant group

participant_idslist of stringsOptional

The ids of participants to be included in the group.

Note, this overwrites any existing participants in the group; use the participant group membership endpoints to append or remove participants from the group.

Response

Request successful.

descriptionstring or null

The user-provided description of the participant group

feeder_studieslist of objectsRead-only

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

idstring

The id of the participant group

is_deletedbooleanRead-only

Whether the participant group has been deleted

namestring

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_countintegerRead-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

Errors

4XX

Client Request Error

1	curl -X PATCH https://api.prolific.com/api/v1/participant-groups/id/ \
2	-H "Authorization: Token <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "Passed all attention checks"
6	}'

1	{
2	"description": "Participants who passed all attention checks",
3	"feeder_studies": [],
4	"id": "642ea7ff7639ab670b05a0b5",
5	"name": "Passed all attention checks",
6	"participant_count": 0,
7	"workspace_id": "5e9b9c9b0f9c9a0001b1ca2f"
8	}