Create or update multiple participants

This endpoint enables you to create or update participants in a batch.

How to use

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

curl --location --request POST /participants/batch \
    --header "Authorization: Bearer ${TOKEN}" \
    --header "apiKey: ${APIKEY}" \
    --header "Content-Type: application/json" \
    --data-raw '[
        {
            "participantId": "1",
            "id": "1",
            "name": "Matt",
            "email": "matt@superviz.com",
            "avatar": "https://example.com/avatar.jpg"
        },
        {
            "participantId": "2",
            "id": "2",
            "name": "Anne",
            "email": "anne@superviz.com",
            "avatar": "https://example.com/avatar.jpg"
        }
    ]'

HTTP Request

POST /participants/batch

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
participant[]	array	Required. The array of participants.
participant[].participantId	string	The ID of the participant.
participant[].name	string	The name of the participant.
participant[].email	string	The email of the participant.
participant[].avatar	string	The avatar of the participant.

Response

Status code 201 will indicate that participants created or updated successfully.