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://api.superviz.com/groups/participants \
    --header "client_id: ${YOUR CLIENT_ID}" \
    --header "secret: ${YOUR SECRET}" \
    --header "Content-Type: application/json" \
    --data-raw '{
        "groups": ["group1", "group2"],
        "participants": ["participant1", "participant2"]
    }'

HTTP Request​

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

Headers​

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

NameDescription
client_idRequired. You need to use the Client ID to authenticate in this repository. You can retrieve your Client ID under the Dashboard > Developer > Keys.
secretRequired. 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:

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.