PATCH

Try PATCH /repos/{owner}/{repo}/releases/{release_id} — GitHub API

GitHub playground

Update a release

Credentials

GitHub token · sent as Authorization

Kept in this tab only. Requests go through apicheats.dev's same-origin proxy straight to api.github.com; the proxy stores and logs nothing about them.

Headers

Accept · fixedX-GitHub-Api-Version · fixed

Path

owner · required · string The account owner of the repository. The name is not case sensitive. repo · required · string The name of the repository without the `.git` extension. The name is not case sensitive. release_id · required · integer The unique identifier of the release.

Body application/json

8 body fields

tag_name · optional · string — The name of the tag.
target_commitish · optional · string — Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch.
name · optional · string — The name of the release.
body · optional · string — Text describing the contents of the tag.
draft · optional · boolean — `true` makes the release a draft, and `false` publishes the release.
prerelease · optional · boolean — `true` to identify the release as a prerelease, `false` to identify the release as a full release.
make_latest · optional · string — Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to `true` for newly published releases. `legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version.
discussion_category_name · optional · string — If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)."