Update a Team

Article summary

Did you find this summary helpful?

Thank you for your feedback

Post

/api/v1/teams.update

Updates an existing team (name and type).

Permission required: edit-team

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 1

{
  "teamId": "ByehQjC44FwMeiLbX",
  "data": {
    "name": "newTeamName",
    "type": 1
  }
}

Expand All

object

teamId

string Required

The team ID.

data

objectRequired

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

name

string

type

integer

Responses

200

Success

{
  "success": true
}

object

success

boolean

Was this article helpful?