Update a channel

PUT /v1/channels/{channelId}

Update a channel

Path parameters

channelId string Required

The id of the channel

application/json

Body Required

name string

The name of the channel.
description string

The description of the channel
emoji string

The emoji of the channel
autoJoin boolean

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

Whether the channel should show its members.
privacy string

Privacy setting of the channel

Values are Private or Public.

Responses

200 application/json

Channel successfully updated
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
404

Channel not found

PUT /v1/channels/{channelId}

curl \
 --request PUT 'https://openapi.meltingspot.io/v1/channels/{channelId}' \
 --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 (200)

{
  "id": "string",
  "name": "string",
  "emoji": "string",
  "description": {},
  "privacy": "Private",
  "autoJoin": true,
  "readonly": true,
  "showMembers": true
}