Create or update a group

This endpoint enables you to create or update a group. If the group does not exist, it will be created. If the group already exists, it will be updated with the new information you provide in the request body.

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} \
    --header "client_id: ${YOUR CLIENT_ID}" \
    --header "secret: ${YOUR SECRET}" \
    --header "Content-Type: application/json" \
		--data-raw '{
			"name": "My Group"
		}'

HTTP Request

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

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 update.

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
name	string	The group name.

Example:

{
  "name": "Red Team",
}

Response

Status code 200 will indicate that the group was created or updated successfully.