Sign in

v1

latestOpenAPI 3.0.0http://www.apache.org/licenses/LICENSE-2.0.html2026-07-14543167.2 KB
groups

Edit a group. All fields are optional, only fields that are provided will be changed.

post/groups/{groupID}

Path parameters

groupIDstring uuid required

The id of the group

Request body

namestring
descriptionstring
isIsolatedboolean

Whether the group is isolated. Refer to Heartbeat docs to learn more about what this entails

isJoinableboolean

Whether the group is joinable. Refer to Heartbeat docs to learn more about what this entails

Example request

{
  "name": "Cohort 1"
}

Response

Successful response