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://nodeapi.superviz.com/groups/participant/{participantId} \
    --header "Authorization: Bearer ${TOKEN}" \
    --header "apikey: ${APIKEY}" \
    --header "Content-Type: application/json" \
    --data-raw '{
        "groups": ["group1", "group2"]
    }'

HTTP Request

PUT https://nodeapi.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 Authorization Bearer token and the API Key. The following headers are required:

Name	Description
Authorization	Required. You must utilize the authentication token.
apikey	Required. You must utilize the SuperViz Token that can be found on the developer page. By utilizing this key, we will define whether to get data from the developer or the production environment.

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.