Requires MANAGE_CHANNELS. The channel ID must be unique and contain 1-64 letters, digits, underscores, or hyphens, beginning with a letter or digit.

Request

POST http://localhost:8989/api/channels/{channelID}/create

Path parameters

Parameter name Value Description Additional
channelID string

Channel identifier.

Required

Request body

The request body takes a complete Create Channel Request resource, containing the following writable properties:

{
    "type": "string"
}

Properties

Name Type Description Additional
type string

Possible values are:

  • text
  • voice

Authorisation

This request requires the use of one of following authorisation methods: API key .

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
201 Created

Channel created.

Channel Mutation Response
400 Bad Request

The request is invalid, references a missing resource, or conflicts with existing state.

Error Response
401 Unauthorized

The Authorization header is missing or malformed.

Error Response
403 Forbidden

The token is invalid or expired, or the requester lacks a required permission.

Error Response
500 Internal Server Error

The server could not complete the operation.

Error Response

Explore this API

channelID

Channel identifier.

body
Request Content-Type
Response Content-Type

Choose an authorisation method:

API key API key to be used for request
Try it out!