PRprolific
participantGroups

Create a new participant group within a workspace

Changed on
post/api/v1/participant-groups/

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/participant-groups/
  • Auth
    API key in header Authorization

Request body

workspace_idstring

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

organisation_idstring

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

namestring required

The name of the participant group

descriptionstring

A description of the participant group

participant_idsstring[]

The ids of participants to be initially added to the group

Response

Participant group created

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

Changes

  • 6c9aa73fa51fRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API

  • e9e1e322aacbRevision changes
    • info

      api operation id create-participant-group removed and replaced with participantGroups_CreateParticipantGroup