Skip to main content
POST
/
api
/
v1
/
groups
/
supergroups
Create Supergroup
curl --request POST \
  --url https://api.checkpoint.b-digital.uk/api/v1/groups/supergroups \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "instance_id": "<string>",
  "description": "<string>",
  "type": "<string>",
  "purpose": "<string>",
  "notifications": true
}
'
{
  "success": true,
  "data": {},
  "meta": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Body

application/json
name
string
required
instance_id
string
required
description
string
type
string
purpose
string
notifications
boolean
default:true

Response

201 - application/json

Supergroup created successfully

success
boolean
Example:

true

data
object
meta
object