Sign in

v1

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

Create a new voice channel in a Heartbeat community

put/voiceChannels

Request body

namestring required
descriptionstring
isPrivateboolean
channelCategoryIDstring uuid required

The id for the category where the channel should be created

invitedUsersstring[]

A list of emails corresponding to the users that can access this channel. If the channel is private, only these users will be able to access the voice channel. If both invitedUsers & invitedGroups are provided, the lists will be combined.

invitedGroupsstring[]

If the voice channel is private, only these groups will be able to access the channel. If both invitedUsers & invitedGroups are provided, the lists will be combined.

Example request

{
  "name": "random",
  "description": "A place to discuss anything you want"
}

Response

Successful response