Login
    Contents x
    Set Group Purpose
      • Print
      • Dark
        Light
      • PDF
      Contents

      Set Group Purpose

        • Print
        • Dark
          Light
        • PDF
        Article summary

        Post
        /api/v1/groups.setPurpose

        Sets the description for the group/channel (the same as groups.setDescription, obsolete).

        Changelog

        VersionDescription
        0.48.0Added
        Header parameters
        X-Auth-Token
        stringRequired

        The authToken of the authenticated user.

        ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
        X-User-Id
        stringRequired

        The userId of the authenticated user.

        ExamplerbAXPnMktTFbNpwtJ
        Body parameters
        Example
        {
  "roomId": "ByehQjC44FwMeiLbX",
  "purpose": "Test out everything"
}
        object
        roomId
        string Required

        The group id

        purpose
        string Required

        The group purpose

        Responses
        200

        OK

        Success
        {
  "purpose": "Testing out everything.",
  "success": true
}
        object
        purpose
        string
        success
        boolean
        Was this article helpful?
        What's Next
        Rocket.Chat versions receive support for six months after release.
        Change password!
        Changing your password will log you out immediately. Use the new password to log back in.
        Change profile
        Success!
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.
        Logout