PRprolific
participantGroups

Update a participant group

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

Request

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

Path parameters

idstring required

The id of the participant group

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

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 update-participant-group removed and replaced with participantGroups_UpdateParticipantGroup