Skip to main content
POST
/
api
/
v1
/
groups
/
subgroups
Create Subgroup
curl --request POST \
  --url https://api.example.com/api/v1/groups/subgroups \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "instance_id": "<string>",
  "parent_supergroup_id": "<string>",
  "description": "<string>",
  "type": "<string>",
  "purpose": "<string>",
  "notifications": true
}
'

​
Create Subgroup

Create a new subgroup. The subgroup must belong to a parent supergroup, and the name must be unique within that parent supergroup.
​
name
string
required
Subgroup name
​
instance_id
string
required
Instance ID
​
parent_supergroup_id
string
required
Parent supergroup ID
​
description
string
Subgroup description
​
type
string
Type (default: subgroup)
​
purpose
string
Purpose
​
notifications
boolean
Enable notifications (default: true)
  • Subgroup names must be unique within the same parent supergroup
  • Parent supergroup must exist and belong to the same instance

​
Example Request

curl -X POST https://api.checkpoint.b-digital.uk/api/v1/groups/subgroups \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Dragon",
    "instance_id": "se8SajpJDWUwrEmhElLF",
    "parent_supergroup_id": "supergroup123",
    "description": "Dragon subgroup"
  }'