Add participants to a participant group

Append participants to a participant group if they are not already members. If a participant is already a member of the group, they will be ignored.

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

The id of the participant group to add the participant to

Request

This endpoint expects an object.

participant_idslist of stringsOptional

Response

All participant(s) now in participant group

resultslist of objects or null

1	import requests
2
3	url = "https://api.prolific.com/api/v1/participant-groups/id/participants/"
4
5	payload = { "participant_ids": ["5e9b9c9b0f9c9a0001b0b1f4", "5e9b9c9b0f9c9a0001b0b1f5", "5e9b9c9b0f9c9a0001b0b1f6"] }
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	"results": [
3	{
4	"participant_id": "5e9b9c9b0f9c9a0001b0b1f5",
5	"datetime_created": "2020-04-20T12:00:00Z"
6	}
7	]
8	}

Authentication

Path Parameters

Request

Response

Errors