Create or update participant

This endpoint enables you to create or update a participant.

How to use

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

curl --location --request POST https://api.superviz.com/participants \
    --header "Content-Type: application/json" \
    --header "client_id: ${YOUR CLIENT_ID}" \
    --header "secret: ${YOUR SECRET}" \
    --data-raw '{
        "participantId": "123",
        "id": "123",
        "name": "John Doe",
        "email": "john@superviz.com",
        "avatar": "https://www.superviz.com/avatar.png"
    }'

HTTP Request

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

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
participantId	string	The ID of the participant.
name	string	The name of the participant.
email	string	The email of the participant.
avatar	string	The avatar of the participant.

Response

Status code 201 will indicate that the participant was created or updated successfully.