Unarchive a participant
This endpoint enables you to restore a participant from the archive.
How to use
You can use the following cURL to obtain a response from this endpoint:
curl --location --request PUT https://nodeapi.superviz.com/participants/{id}/unarchive \
--header "Authorization: Bearer ${TOKEN}" \
--header "apikey: ${APIKEY}"
HTTP Request
PUT https://nodeapi.superviz.com/participants/{id}/unarchive
In the request, you will need to send in the path following field:
Name | Description |
---|---|
id | Required. The ID of the participant you want to restore. |
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. |
Response
Status code 200 will indicate that the participant restored successfully. The response will be in JSON format and include the following fields:
Name | Type | Description |
---|---|---|
id | 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. |
createdAt | string | The date and time of the participant's creation. |
Example:
{
"id": "example-id",
"name": "John Doe",
"email": "john@doe.com",
"avatar": "https://example.com/avatar.png",
"createdAt": "2021-05-30T21:23:00.000Z"
}