Skip Navigation Links

Channels

List Channels

Requires authentication via bearer.

Gets all channels that are visible to the user.

Query Params

search_term string

A term that needs a a match in the channel's name, description or external id.

managing_user_group_id string

Filters the result to only contains channels managed by the provided user group.

states string[]

Indicates the state of the channel.

sort string[]
embed string[]
page_number integer

requested page for offset based pagination. Refer to our general "pagination" concept for more information.

page_limit integer

The maximum number of items to be contained in the response array. Refer to our general "pagination" concept for more information.

Headers

Accept-Language string

The preferred language used when returning localized strings.

Response Body

200 OK

Create Channel

Requires authentication via bearer.

Creates a channel. By default, the channel will have no members and will be visible for all users that can manage channels.

Request Body

name stringrequired

The name of the channel.

managing_user_group_id string

The primary identifier of the user group that manages the channel. This controls which users can access the channel in the admin console. If not specified, the root user group will be used.

description string

The description of the channel.

avatar_id string

The file identifier of the avatar image of the channel.

banner_id string

The file identifier of the banner image of the channel.

channel_settings object

Response Body

201 Created

Error Codes

  • ASSIGNMENT_DOES_NOT_EXIST
  • CHANNEL_DOES_NOT_EXIST
  • ROLE_DOES_NOT_EXIST

Update multiple channels

Requires authentication via bearer.

Updates multiple channels. For the actual semantics of updating channels, consult the documentation of the single channel update endpoint.

Request Body

items object[]

A single channel that should be updated.

Response Body

200 OK

Get Channel

Requires authentication via bearer.

Gets the channel with the specified id.

Path Params

channel_id stringrequired

The primary identifier of the channel to access.

Query Params

embed string[]

Headers

Accept-Language string

The preferred language used when returning localized strings.

Response Body

200 OK

Update channel

Requires authentication via bearer.

Updates the channel with the specified id.

Path Params

channel_id stringrequired

The primary identifier of the channel to access.

Request Body

name string

The name of the channel.

managing_user_group_id string

The primary identifier of the user group that manages the channel. This controls which users can access the channel in the admin console.

description string

The description of the channel.

avatar_id string

The primary identifier of the avatar of the channel.

banner_id string

The primary identifier of the banner of the channel.

channel_settings object

Response Body

200 OK

Error Codes

  • ASSIGNMENT_DOES_NOT_EXIST
  • CHANNEL_DOES_NOT_EXIST
  • ROLE_DOES_NOT_EXIST

Archive channel

Requires authentication via bearer.

Archive a given channel.

Path Params

channel_id stringrequired

The primary identifier of the channel to archive.

Response Body

200 OK