Sign in

v1

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

Create a new Channel in a Heartbeat community

put/channels

Request body

namestring required
descriptionstring
isPrivateboolean required
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 channel. If both invitedUsers & invitedGroups are provided, the lists will be combined.

invitedGroupsstring[]

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

isReadOnlyboolean

If true, only admins & moderators will be able to create threads in this channel. This option is not currently available for chat channels

channelType'POSTS' | 'CHAT'

Thread channels are created by default

Example request

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

Response

Successful response