Sign in

v1

latestOpenAPI 3.0.02026-08-0417295208.0 KB
groups

Edit a group

Edits the group specified by the group name

put/groups/{group_id}

Path parameters

group_idstring required

Request body

namestring required

the name of the group

descriptionstring required

the description of the group

Example request

{
  "name": "ui-team",
  "description": "ui-team description"
}

Response

successfully edited the specified subchannel

idstring
namestring

This can be any string based name

descriptionstring
parentstring

name of parent channel

privacy'private' | 'authenticated' | 'public'

channel privacy channel

channel_type'default' | 'virtual'

channel type

indexing_behavior'default' | 'frozen'

channel indexing behavior

createdstring

date created

updatedstring

date of last update

Example response

{
  "name": "dev, prod, test, main, utility, ui"
}