Skip to main content

Add participants to groups

This endpoint enables you to add many participants to a specific group.

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/participants \
    --header "Authorization: Bearer ${TOKEN}" \
    --header "apikey: ${APIKEY}" \
    --header "Content-Type: application/json" \
    --data-raw '{
        "groups": ["group1", "group2"],
        "participants": ["participant1", "participant2"]
    }'

HTTP Request​

POST https://nodeapi.superviz.com/groups/participants

Headers​

When using this endpoint, you need to provide the Authorization Bearer token and the API Key. The following headers are required:

NameDescription
AuthorizationRequired. You must utilize the authentication token.
apikeyRequired. 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:

NameTypeDescription
groupsstring[]Required. The IDs of the groups to add the participants to.
participantsstring[]Required. The IDs of the participants to add to the groups.

Response​

Status code 201 will indicate that participants were added to the groups provided.