delete_team: Delete a team in GitHub

In ChadGoymer/githapi: User-friendly access to the GitHub API for R

Description

This function deletes a team from an organization in GitHub, as long as you have appropriate permissions. Care should be taken as it will not be recoverable.

Usage

delete_team(team, org, ...)

Arguments

team	(integer or string) The ID or name of the team.
org	(string) The login of the organization.
...	Parameters passed to gh_request().

Details

For more details see the GitHub API documentation:

• https://docs.github.com/en/rest/reference/teams#delete-a-team

Value

delete_team() returns a TRUE if successfully deleted.

Examples

## Not run: 

  # Delete a team
  delete_team("HeadCoos", "HairyCoos")


## End(Not run)

ChadGoymer/githapi documentation built on Oct. 22, 2021, 10:56 a.m.