GitHub: Update a team (Legacy)

← Teams operations · Get started

Operation github.teams_update_legacy

Provider route: PATCH /teams/{team_id}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["teams"]["teamsUpdateLegacy"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.teams.teamsUpdateLegacy(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.teams.teams_update_legacy(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.team_id	integer	Required within parent
body	object	Required within parent
body.description	string	Optional	The description of the team.
body.name	string	Required within parent	The name of the team.
body.notification_setting	string	Optional	The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: * `notifications_enabled` - team members receive notifications when the team is @mentioned. * `notifications_disabled` - no one receives notifications. One of: notifications_enabled, notifications_disabled
body.parent_team_id	JSON	Optional
body.parent_team_id (anyOf 1)	integer	Alternative	The ID of a team to set as the parent team.
body.parent_team_id (anyOf 2)	null	Alternative
body.parent_team_slug	JSON	Optional
body.parent_team_slug (anyOf 1)	string	Alternative	The slug of a team to set as the parent team. Ignored when `parent_team_id` is also provided.
body.parent_team_slug (anyOf 2)	null	Alternative
body.permission	string	Optional	Closing down notice. The permission that new repositories will be added to the team with when none is specified. Default: pull One of: pull, push, admin
body.privacy	string	Optional	The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: For a non-nested team: * `secret` - only visible to organization owners and members of this team. * `closed` - visible to all members of this organization. For a parent or child team: * `closed` - visible to all members of this organization. One of: secret, closed

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Create a team — response body
$ (anyOf 2)	Model	Alternative	Expand Create a team — response body

Referenced models: Create a team — response body

Schemas

1 more schema is linked from the tables above, on the schema pages.

Create a team — response body

Field	Type	Presence	Description and constraints
$	object	Root	Groups of organization members that gives permissions on specified repositories.
created_at	string	Required within parent	Format: date-time
description	JSON	Required within parent
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
enterprise_id	JSON	Optional
enterprise_id (anyOf 1)	integer	Alternative	Unique identifier of the enterprise to which this team belongs
enterprise_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
html_url	string	Required within parent	Format: uri
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	Unique identifier of the team
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
ldap_dn	string	Optional	The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.
members_count	JSON	Required within parent
members_count (anyOf 1)	integer	Alternative
members_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
members_url	string	Required within parent
name	string	Required within parent	Name of the team
node_id	string	Required within parent
notification_setting	string	Optional	The notification setting the team has set Known values: notifications_enabled, notifications_disabled
organization	Model	Required within parent	Expand Create a team — response body — organization
organization_id	JSON	Optional
organization_id (anyOf 1)	integer	Alternative	Unique identifier of the organization to which this team belongs
organization_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
parent	Model	Optional	Expand Create a team — response body — parent
permission	string	Required within parent	Permission that the team will have for its repositories
privacy	string	Optional	The level of privacy this team should have Known values: closed, secret
repos_count	JSON	Required within parent
repos_count (anyOf 1)	integer	Alternative
repos_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
repositories_url	string	Required within parent	Format: uri
slug	string	Required within parent
type	string	Required within parent	The ownership type of the team Known values: enterprise, organization
updated_at	string	Required within parent	Format: date-time
url	string	Required within parent	URL for the team Format: uri

Referenced models: Create a team — response body — parent, Create a team — response body — organization

Create a team — response body — parent

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Create a team — response body — parent / type: enterprise, organization
$ (anyOf 2)	null	Alternative

Referenced models: Create a team — response body — parent / type: enterprise, organization

Create a team — response body — parent / type: enterprise, organization

Field	Type	Presence	Description and constraints
$	object	Root	Groups of organization members that gives permissions on specified repositories.
description	JSON	Required within parent
description (anyOf 1)	string	Alternative	Description of the team
description (anyOf 2)	null	Alternative
enterprise_id	JSON	Optional
enterprise_id (anyOf 1)	integer	Alternative	Unique identifier of the enterprise to which this team belongs
enterprise_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
html_url	string	Required within parent	Format: uri
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	Unique identifier of the team
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
ldap_dn	string	Optional	Distinguished Name (DN) that team maps to within LDAP environment
members_url	string	Required within parent
name	string	Required within parent	Name of the team
node_id	string	Required within parent
notification_setting	string	Optional	The notification setting the team has set
organization_id	JSON	Optional
organization_id (anyOf 1)	integer	Alternative	Unique identifier of the organization to which this team belongs
organization_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
permission	string	Required within parent	Permission that the team will have for its repositories
privacy	string	Optional	The level of privacy this team should have
repositories_url	string	Required within parent	Format: uri
slug	string	Required within parent
type	string	Required within parent	The ownership type of the team Known values: enterprise, organization
url	string	Required within parent	URL for the team Format: uri

Get an organization — response body — plan

Field	Type	Presence	Description and constraints
$	object	Root
filled_seats	JSON	Optional
filled_seats (anyOf 1)	integer	Alternative
filled_seats (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
name	string	Required within parent
private_repos	JSON	Required within parent
private_repos (anyOf 1)	integer	Alternative
private_repos (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
seats	JSON	Optional
seats (anyOf 1)	integer	Alternative
seats (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
space	JSON	Required within parent
space (anyOf 1)	integer	Alternative
space (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: github.teams_update_legacy. Catalog operation: teams/update-legacy. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source