Sign in

v4

OpenAPI 3.1.02026-07-31121440441.0 KB
participantGroups

Update a participant group

patch/api/v1/participant-groups/{id}/

Path parameters

idstring required

The id of the participant group

Headers

Authorizationstring required

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 body

namestring

The name of the participant group

participant_idsstring[]

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.

idstring

The id of the participant group

namestring

The name of the participant group

project_idstring nullable

The id of the project the participant group belongs to

workspace_idstring nullable

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

organisation_idstring nullable

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

descriptionstring nullable

The user-provided description of the participant group

participant_countinteger

The number of participants in the participant group

is_deletedboolean

Whether the participant group has been deleted