delete_card: Delete a card in a GitHub project

Description Usage Arguments Details Value Examples

Description

This function deletes a card in a GitHub project. Care should be taken as it will not be recoverable. Instead, you may way to archive the card with update_card().

Usage

1

Arguments

card

(integer) The ID of the card.

...

Parameters passed to gh_request().

Details

You can delete a card associated with either a repository, user or organization, by supplying them as an input, as long as you have appropriate permissions.

For more details see the GitHub API documentation:

Value

delete_card() returns a TRUE if successfully deleted.

Examples

1
2
3
4
5
6
7
## Not run: 

  # Delete a card
  delete_card(card = 123456)


## End(Not run)

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