Add Members to Team

Requires add-team-member or edit-team-member permissions.

HTTP MethodURLRequires Auth



Body Parameters

KeyExample ValueDescription

teamId* or teamName*

ByehQjC44FwMeiLbX or team1

The team ID or the team name. You must enter either one of these parameters.


[{ "userId": "8dugqGhuRvCBLdZft", "roles": ["member"] }]

The users (IDs and roles) to add to the team.

Example Call

curl  -H "X-Auth-Token: 8h2mKAwxB3AQrFSjLVKMooJyjdCFaA7W45sWlHP8IzO" \
      -H "X-User-Id: ew28FnZqipDpvKw3R" \
      -H "Content-type: application/json" \
      http://localhost:3000/api/v1/teams.addmembers \
      -d '{ 
            "teamId": "Isjsldk32sdkfA", 
            "members": [{ "userId": "aobEdbYhXfu5hkeqG", "roles": ["owner"]}] }'

Example Response

  "success": true

Last updated

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