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 and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.

Servers

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:

  • "push"
  • "admin"
  • "pull"

Default value: "pull"

notification_setting String No

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.

Possible values:

  • "notifications_enabled"
  • "notifications_disabled"
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 privacy intact. When a team is nested, the privacy for parent teams cannot be secret. 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.

Possible values:

  • "secret"
  • "closed"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.