---
title: "Set Channel Purpose"
slug: "set-channel-purpose"
updated: 2026-09-03T14:50:33Z
published: 2026-09-03T14:50:33Z
canonical: "developer.rocket.chat/set-channel-purpose"
stale: true
---

> ## Documentation Index
> Fetch the complete documentation index at: https://developer.rocket.chat/llms.txt
> Use this file to discover all available pages before exploring further.

# Set Channel Purpose

Post/api/v1/channels.setPurpose

Set the purpose or description of the channel. It is the same as Set Channel Description. Permission required: `edit-room`

### Changelog

| Version | Description |
| --- | --- |
| 0.48.0 | Added |

Header parametersX-Auth-TokenstringRequired

The `authToken` of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-IdstringRequired

The `userId` of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ

Body parameters<select class='api-response-data' aria-label='Media type'><option value='303cc1cd-96d5-4192-9f39-0c947d30dbd2'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='026261f2-c8f8-4518-acba-82c1a722df07'>Example</option>
</select>Example

```json
{
  "roomId": "WDuJLFkjwk6L7LdFC",
  "purpose": "greetings"
}
```

object  roomIdstring    Required

The channel's id

purposestring    Required

The description to set for the channel.

Responses200

OK

<select class='api-response-data' aria-label='Media type'><option value='6bdcfea8-1ba7-4f49-bfac-ec2009cc83a5'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='414c6c12-e196-4dd9-b657-1d118288d7d2'>Success</option>
</select>Success

```json
{
  "purpose": "greetings",
  "success": true
}
```

object  purposestring    
successboolean    

401

Unauthorized

<select class='api-response-data' aria-label='Media type'><option value='52bb5f46-001d-4956-ab0d-87dc342225ae'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='4b074a20-8ab6-4a23-9e2a-7a56e8f354c1'>Authorization Error</option>
</select>Authorization Error

```json
{
  "status": "error",
  "message": "You must be logged in to do this."
}
```

object  statusstring    
messagestring