Skip to content

Delete a group

DELETE
/api/v1/groups/{id}
curl --request DELETE \
--url http://localhost:3000/api/v1/groups/example \
--header 'Authorization: Bearer <token>'

Its grants go with it: members keep what they hold themselves.

Any caller; the scope needed is checked on what it acts on.

id
required
string

Group id

Deleted

Media typeapplication/json
object
data
required
object
deleted
required
boolean
Example
{
"data": {
"deleted": true
}
}

An error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
detail
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"detail": "example"
}
}