PATCH /orgs/{org}/teams/{team_slug}
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
[!NOTE] You can also specify a team by
org_id
andteam_id
using the routePATCH /organizations/{org_id}/team/{team_id}
.
Servers
- https://api.github.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
team_slug |
String | Yes |
The slug of the team name. |
org |
String | Yes |
The organization name. The name is not case sensitive. |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
permission |
String | No |
Closing down notice. The permission that new repositories will be added to the team with when none is specified. Possible values:
Default value: "pull" |
notification_setting |
String | No |
The notification setting the team has chosen. Editing teams without specifying this parameter leaves
Possible values:
|
name |
String | No |
The name of the team. |
description |
String | No |
The description of the team. |
parent_team_id |
Integer | No |
The ID of a team to set as the parent team. |
privacy |
String | No |
The level of privacy this team should have. Editing teams without specifying this parameter leaves
Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.