Sign in

v1

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

Create a new Group in a Heartbeat community

put/groups

Request body

namestring required
descriptionstring
membersstring[]

The email addresses of the users that should be added to the group

parentGroupIDstring uuid

The id of the parent group

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