Add participant to a group

This endpoint enables you to add a participant to a group, by providing the participant ID and the group ID.

How to use

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

curl --location --request POST 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

POST 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 add to 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 add the participant to.

Response

Status code 201 will indicate that the participant was added to the group.