---
title: "Set Channel Purpose"
slug: "set-channel-purpose"
updated: 2026-06-08T12:46:40Z
published: 2026-06-08T12:46:40Z
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='9a48db02-c4d8-4bbb-aa3a-32afeb284a01'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='68a82c10-43aa-4944-be5a-ae419e70afcf'>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='8900b7a5-f918-405b-9831-9f378a1f92d5'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='e969fe88-3a6e-4be9-9df5-6507fb023185'>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='d29a0c07-f133-49b4-801a-9cfa68a4cb58'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='9516d26f-11ad-43e4-a0dc-60866742252b'>Authorization Error</option>
</select>Authorization Error

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

object  statusstring    
messagestring