Skip to main content
PUT
/
api
/
servers
/
{serverID}
/
channels
/
{channelID}
/
archive
Archive or unarchive a channel
curl --request PUT \
  --url http://localhost:8091/api/servers/{serverID}/channels/{channelID}/archive \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "archived": true
}
'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "displayName": "<string>",
    "topic": "<string>",
    "isDm": true,
    "isPrivate": true,
    "archived": true,
    "createdBy": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "position": 123,
    "serverId": "<string>",
    "memberCount": 123,
    "groupId": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Session token obtained from /api/auth/login or /api/auth/register. Pass as: Authorization: Bearer

Path Parameters

​
serverID
string
required

Server ID

​
channelID
string
required

Channel ID

Body

application/json
​
archived
boolean
required

True to archive, false to unarchive

Response

Channel archive status updated

​
data
object