API ReferenceParticipant Groups

Update a participant group

View as MarkdownOpen in Claude

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](#tag/Participant-Groups/operation/AddToParticipantGroup) or [remove](#tag/Participant-Groups/operation/RemoveFromParticipantGroup) participants from the group.

Response

Request successful.
descriptionstring or null

The user-provided description of the participant group

feeder_studieslist of objects or nullRead-only
Details of all studies which are configured to modify the participants in this group through completion codes.
idstring or null
The id of the participant group
is_deletedboolean or nullRead-only
Whether the participant group has been deleted
namestring or null
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_countinteger or nullRead-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