API

Create a channel

POST /v1/channels

Create a channel

application/json

Body Required

  • name string Required

    The name of the channel.

  • description string

    The description of the channel

  • emoji string

    The emoji of the channel

  • autoJoin boolean Required

    Whether the channel should be auto-joined by new members.

  • showMembers boolean Required

    Whether the channel should show its members.

  • privacy string Required

    Privacy setting of the channel

    Values are Private or Public.

Responses

  • 201 application/json

    Channel has been successfully created

    Hide response attributes Show response attributes object
    • id string Required

      The id of the channel.

    • name string Required

      The name of the channel.

    • emoji string

      The emoji of the channel

    • description object | null Required

      The description of the channel.

    • privacy string Required

      The privacy of the channel.

      Values are Private or Public.

    • autoJoin boolean Required

      Whether the channel will be auto-joined by new members.

    • readonly boolean Required

      Whether the channel will be in read-only for non admin.

    • showMembers boolean Required

      Whether the channel will show its members.
  • 400

    Malformed payload

POST /v1/channels 
curl \
 --request POST 'https://openapi.meltingspot.io/v1/channels' \
 --header "Content-Type: application/json" \
 --data '{"name":"string","description":"string","emoji":"string","autoJoin":true,"showMembers":true,"privacy":"Private"}'
Request examples 
{
  "name": "string",
  "description": "string",
  "emoji": "string",
  "autoJoin": true,
  "showMembers": true,
  "privacy": "Private"
}
Response examples (201) 
{
  "id": "string",
  "name": "string",
  "emoji": "string",
  "description": {},
  "privacy": "Private",
  "autoJoin": true,
  "readonly": true,
  "showMembers": true
}