Archive group

This endpoint enables you to archive a group. By doing that the group will not be active anymore and will not be found when getting a list of groups.

How to use

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

curl --location --request PUT https://api.superviz.com/groups/{id}/archive \
    --header "client_id: ${YOUR CLIENT_ID}" \
    --header "secret: ${YOUR SECRET}"

HTTP Request

PUT https://api.superviz.com/groups/{id}/archive

In the request, you will need to send in the path following field:

Name	Description
id	Required. The ID of the group you want to archive.

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.

Response

Status code 200 will indicate that the request was successful. The response will be in JSON format and include the following fields:

Name	Type	Description
id	string	The group ID.
name	string	The group name.
createdAt	string	The group creation date.

Example:

{
  "id": "example-id",
  "name": "Red Team",
  "createdAt": "2021-05-30T21:23:00.000Z"
}