Skip to content
forgit api docs

Update an enterprise team

PATCH
/enterprises/{enterprise}/teams/{team_slug}

To edit a team, the authenticated user must be an enterprise owner.

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
enterprise
required
string

The slug version of the enterprise name.

team_slug
required
string

The slug of the team name.

Request Body required

Section titled “ Request Body required ”
Media type application/json
object
name

A new name for the team.

string
nullable
description

A new description for the team.

string
nullable
sync_to_organizations

Retired: this field is no longer supported. Whether the enterprise team should be reflected in each organization. This value cannot be changed.

string
default: disabled
Allowed values: all disabled
organization_selection_type

Specifies which organizations in the enterprise should have access to this team. Can be one of disabled, selected, or all. disabled: The team is not assigned to any organizations. This is the default when you create a new team. selected: The team is assigned to specific organizations. You can then use the add organization assignments API. all: The team is assigned to all current and future organizations in the enterprise.

string
default: disabled
Allowed values: disabled selected all
group_id

The ID of the IdP group to assign team membership with. The new IdP group will replace the existing one, or replace existing direct members if the team isn’t currently linked to an IdP group.

string
nullable
notification_setting

The notification setting the team is set to. The options are:

  • notifications_enabled - team members receive notifications when the team is @mentioned.
  • notifications_disabled - no one receives notifications.
string
Allowed values: notifications_enabled notifications_disabled
Examples
Example default 
{
  "name": "Justice League",
  "description": "A great team.",
  "group_id": "62ab9291-fae2-468e-974b-7e45096d5021"
}

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
Enterprise Team

Group of enterprise owners and/or members

object
id
required
integer format: int64
name
required
string
description
string
slug
required
string
url
required
string format: uri
sync_to_organizations

Retired: this field will not be returned with GHEC enterprise teams.

string
organization_selection_type
string
group_id
required
string
nullable
group_name

Retired: this field will not be returned with GHEC enterprise teams.

string
nullable
html_url
required
string format: uri
members_url
required
string
created_at
required
string format: date-time
updated_at
required
string format: date-time
notification_setting

Whether team members will receive notifications when the team is mentioned.

string
Allowed values: notifications_enabled notifications_disabled
Examples
Example default 
{
  "id": 1,
  "name": "Justice League",
  "description": "A great team.",
  "slug": "justice-league",
  "url": "https://api.github.com/enterprises/dc/teams/justice-league",
  "group_id": "62ab9291-fae2-468e-974b-7e45096d5021",
  "html_url": "https://github.com/enterprises/dc/teams/justice-league",
  "members_url": "https://api.github.com/enterprises/dc/teams/justice-league/members{/member}",
  "created_at": "2019-01-26T19:01:12Z",
  "updated_at": "2019-01-26T19:14:43Z"
}

Headers

Section titled “ Headers ”
Link
string
Example 
<https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last"

403

Section titled “ 403 ”

Forbidden

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}