Update a participant's group list

This endpoint enables you to update all groups of specific participants, by sending a list of group IDs. This will override the existing groups list.

How to use

You can use the following cURL to obtain a response from this endpoint:

curl --location --request PUT https://api.superviz.com/groups/participant/{participantId} \
    --header "client_id: ${YOUR CLIENT_ID}" \
    --header "secret: ${YOUR SECRET}" \
    --header "Content-Type: application/json" \
    --data-raw '{
        "groups": ["group1", "group2"]
    }'

HTTP Request

PUT https://api.superviz.com/groups/participant/{participantId}

In the request, you will need to send in the path following field:

Name	Description
participantId	Required. The ID of the participant.

Headers

When using this endpoint, you need to provide the Client ID and Secret Key. The following headers are required:

Name	Description
client_id	Required. You need to use the Client ID to authenticate in this repository. You can retrieve your Client ID under the Dashboard > Developer > Keys.
secret	Required. You need to use the Secret Key to authenticate in this repository. You can create a new API Secret under our Dashboard > Developer > Keys.

Request Body

When sending a request, include the following fields in JSON format:

Name	Type	Description
groups	string[]	Required. The list of group IDs.

Response

Status code 200 will indicate that groups updated.