Create channel

POST

/api/channels/create

curl --request POST \
  --url http://localhost:3001/api/channels/create \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "avatar_chunk_id": 1, "avatar_key": "example", "description": "example", "initial_members": [ "example" ], "name": "example", "type": "example" }'

• Local development
• Production

Create a new broadcast channel.

Authorizations

• BearerAuth

Request Body^required

Channel creation request

Media typeapplication/json

object

avatar_chunk_id

integer

avatar_key

Base64-encoded

string

description

string

initial_members

Addresses to add as initial subscribers

Array<string>

name

string

type

“public” or “private”

string

Example^generated

{
  "avatar_chunk_id": 1,
  "avatar_key": "example",
  "description": "example",
  "initial_members": [
    "example"
  ],
  "name": "example",
  "type": "example"
}

Responses

200

OK

Media typeapplication/json

object

key

additional properties

any

Example^generated

{}

400

Bad Request

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}

401

Unauthorized

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}

409

Conflict

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}

500

Internal Server Error

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}