Update a Team

Updates an existing team (name and type). Requires edit-team permission.

HTTP MethodURLRequires Auth

POST

/api/v1/teams.update

Body Parameters

KeyExample ValueDescription

teamId*

ByehQjC44FwMeiLbX

The team ID.

data*

{ "name": "newTeamName", "type": 1 }

The new team name and type (0 - public, 1 - private).

Example Call

curl -H 'X-Auth-Token: _2u_4MzRroRcnqc59GYUY_Kwgr9HgtZ9HCKn-2aIvMJ' \
     -H 'X-User-Id: FL2fZL4ERhwA3gWiS' \
     -H 'Content-Type: application/json' \
     http://localhost:3000/api/v1/teams.update \
     -d '{ 
          "teamId": "ByehQjC44FwMeiLbX", 
          "data": { "name": "newTeamName", "type": 1 }}'

Example Response

{
  "success": true
}

Last updated

Rocket.Chat versions receive support for six months after release.