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 "Content-Type: application/json" \
    --header "client_id: ${YOUR CLIENT_ID}" \
    --header "secret: ${YOUR SECRET}" \
    --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 Client ID and Secret Key. The following headers are required:

Name	Description
client_id	Required. You need to use the Client ID to authenticate in this repository. You can retrieve your Client ID under the Dashboard > Developer > Keys.
secret	Required. 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:

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.