Skip to content

Create a channel

POST
/api/chat/channels

Owners and managers only. Channel names are unique per band, case-insensitively.

Channel to create

object
name
required
string
>= 1 characters <= 100 characters
type
string
default: general
Allowed values: general gig setlist
referenceId
string format: uuid
visibleToRoles
Array<string>
>= 1 items
Allowed values: owner manager member guest tech
postRoles
Array<string>
>= 1 items
Allowed values: owner manager member guest tech

Created

object
ok
required
boolean
data
nullable

Invalid input

object
ok
required
boolean
error
required
string
code
string

Unauthenticated

object
ok
required
boolean
error
required
string
code
string

Forbidden

object
ok
required
boolean
error
required
string
code
string

A channel with that name already exists

object
ok
required
boolean
error
required
string
code
string

Server error

object
ok
required
boolean
error
required
string
code
string