Skip to content
forgit api docs

Edit a team

PATCH
/teams/{id}

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
id
required
integer format: int64

Id of the team to edit

Request Body

Section titled “ Request Body ”
Media type application/json

EditTeamOption options for editing a team

object
can_create_org_repo
boolean
description
string
includes_all_repositories
boolean
name
required
string
permission
string
Allowed values: read write admin
units
Array<string>
Example 
[
  "repo.code",
  "repo.issues",
  "repo.ext_issues",
  "repo.wiki",
  "repo.pulls",
  "repo.releases",
  "repo.projects",
  "repo.ext_wiki"
]
units_map
object
key
additional properties
string
Example 
{
  "repo.actions": "none",
  "repo.code": "read",
  "repo.ext_issues": "none",
  "repo.ext_wiki": "none",
  "repo.issues": "write",
  "repo.packages": "none",
  "repo.projects": "none",
  "repo.pulls": "owner",
  "repo.releases": "none",
  "repo.wiki": "admin"
}

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Team

Media type application/json

Team represents a team in an organization

object
can_create_org_repo
boolean
description
string
id
integer format: int64
includes_all_repositories
boolean
name
string
organization

Organization represents an organization

object
avatar_url
string
created
string format: date-time
description
string
email
string
full_name
string
id
integer format: int64
location
string
name
string
repo_admin_change_team_access
boolean
username

Deprecated

string
visibility
string
website
string
permission
string
Allowed values: none read write admin owner
units
Array<string>
units_map
object
key
additional properties
string
Example 
{
  "permission": "none",
  "units": [
    "repo.code",
    "repo.issues",
    "repo.ext_issues",
    "repo.wiki",
    "repo.pulls",
    "repo.releases",
    "repo.projects",
    "repo.ext_wiki"
  ],
  "units_map": {
    "repo.actions": "none",
    "repo.code": "read",
    "repo.ext_issues": "none",
    "repo.ext_wiki": "none",
    "repo.issues": "write",
    "repo.packages": "none",
    "repo.projects": "none",
    "repo.pulls": "owner",
    "repo.releases": "none",
    "repo.wiki": "admin"
  }
}

404

Section titled “ 404 ”

APINotFound is a not found error response

Media type application/json
object
errors
Array<string>
message
string
url
string
Example generated 
{
  "errors": [
    "example"
  ],
  "message": "example",
  "url": "example"
}