Remove a participant from a group

This endpoint enables you to remove a group of specific participants from a group.

How to use

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

curl --location --request DELETE https://nodeapi.superviz.com/groups/participant/{participantId} \
    --header "Authorization: Bearer ${TOKEN}" \
    --header "apikey: ${APIKEY}" \
    --header "Content-Type: application/json" \
    --data-raw '{
        "group_id": "group_id"
    }'

HTTP Request

DELETE 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 you want to remove from the group.

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
group_id	string	Required. The ID of the group you want to remove the participant from.

Response

Status code 200 will indicate that the group was removed.