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://nodeapi.superviz.com/groups/{id} \
		--header "Authorization: Bearer ${TOKEN}" \
		--header "apikey: ${APIKEY}" \
		--header "Content-Type: application/json" \
		--data-raw '{
			"name": "My Group"
		}'

HTTP Request

PUT https://nodeapi.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 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.

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.