Skip to main content
POST
Create channel

Authorizations

Authorization
string
header
required

Scoped API key created via POST /api/account/keys.

Path Parameters

session
string
required

Session name

Body

application/json

Channel parameters

name
string
required

Channel display name

Example:

"My Channel"

session
string
required

Session identifier

Example:

"default"

description
string

Channel description/topic

Example:

"Channel description"

profileUrl
string

URL of the channel profile picture

Example:

"https://.../example.png"

Response

OK

description
string

Channel description/topic

followers
integer

Number of channel followers

lid
string

Channel JID (Linked Device ID)

muted
boolean

Whether channel notifications are muted

name
string

Channel display name

preview
boolean

Whether the channel is in preview mode

profileUrl
string

URL of the channel profile picture