Skip to content
GitmoapAPIBeta
Shipreleases
PATCH/repositories/{repo_id}/releases/{tag_name}

Update a release's title, notes, or draft/prerelease flags

update_release
  • release:update
    A token needs the release:update scope: Update releasesGranted by write_api, write_repository.Every operation this scope unlocks
  • Audited · mutation

    x-gitmoap-audit: {"kind":"audited","arg":"mutation"}

Changes only the fields you send. Send the release's version as you last read it: if the release has changed since, the update is refused. Clearing the draft flag publishes the release and stamps its publication time. Developers and above may update releases.

Parameters

Path
  • repo_idRepositoryId (string · uuid)Repository ID
  • tag_nameTagName (string)Tag name

Request body

application/json
  • versioninteger · int640–∞The release's version as you last read it. The update is refused if the release has changed since.
  • bodyReleaseBody (string) or nulloptional
  • draftboolean or nulloptional
  • nameReleaseName (string) or nulloptional
  • prereleaseboolean or nulloptional
Request body exampleSynthesized example
{
"version": 47
}

Responses

200Release updatedapplication/json
  • authorActorSummaryWho created the release.
  • commit_shaCommitHash (string)The commit the tag pointed to when the release was created.
  • created_atstring
  • nameReleaseName (string)
  • repository_idRepositoryId (string · uuid)
  • tag_nameTagName (string)
  • updated_atstring
  • assetsarray of ReleaseAssetoptionalThe release's files. Included when a single release is fetched.
    • The ReleaseAsset schema
    • asset_idReleaseAssetId (string · uuid)
    • content_typestring
    • created_atstring
    • nameAssetName (string)
    • repository_idRepositoryId (string · uuid)
    • sizeinteger · int640–∞
    • stateAssetStateuploadingavailableWhether a release file has been uploaded: uploading (an upload URL was issued, but the upload has not been confirmed yet) or available.
    • tag_nameTagName (string)
    • updated_atstring
    • uploaderActorSummaryWho uploaded the file.
    • download_urlstring or nulloptionalWhere to download the file.
  • bodyReleaseBody (string) or nulloptional
  • draftbooleanoptionalWhether the release is an unpublished draft, visible only to people with Developer access or above.
  • prereleasebooleanoptionalWhether the release is marked as a pre-release. A pre-release is never returned as the latest release.
  • published_atstring or nulloptionalSet when the release leaves draft.
  • tarball_urlstring or nulloptionalWhere to download the tagged source as a .tar.gz archive.
  • versioninteger · int64optional0–∞Increases with every change. Send it with an update so that a change made since you read the release is not overwritten.
  • zipball_urlstring or nulloptionalWhere to download the tagged source as a .zip archive.
200 exampleSynthesized example
{
"author": {
"email": "mara@acme.example",
"id": "id-2de5",
"username": "tomas",
"avatar_url": "https://gitmoap.example/acme/0ccd5efb"
},
"commit_sha": "ac1e07a4ff271f7bf9103b4b3aaaa639812c7c00",
"created_at": "2026-10-17T05:31:03Z",
"name": "payments-api",
"repository_id": "5b0e7c2a-9d14-4e8b-a6f1-2c3d4e5f6a70",
"tag_name": "payments-api",
"updated_at": "2026-10-13T00:58:29Z",
"assets": [
{
"asset_id": "2a1536a0-b117-48ba-965e-5930b784fdd1",
"content_type": "content-type-d426",
"created_at": "2026-10-10T03:05:05Z",
"name": "payments-api",
"repository_id": "5b0e7c2a-9d14-4e8b-a6f1-2c3d4e5f6a70",
"size": 6,
"state": "uploading",
"tag_name": "payments-api",
"updated_at": "2026-10-08T20:25:54Z",
"uploader": {
"email": "lin@acme.example",
"id": "id-552d",
"username": "tomas"
}
}
],
"body": "Renders each region as density contours of its operations.",
"draft": false,
"prerelease": false,
"published_at": "2026-10-10T04:34:57Z",
"tarball_url": "https://gitmoap.example/acme/b4785732",
"version": 45,
"zipball_url": "https://gitmoap.example/acme/6869c91b"
}
400Bad request — a path parameter is not a well-formed value of its typeapplication/json
Error codes
  • BAD_REQUESTThe request is malformed: a parameter or a body field is not a well-formed value of its type
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
400 exampleSynthesized example
{
"error": {
"code": "code-98aa",
"message": "Inline scalar newtypes but keep their brand"
}
}
401Unauthenticated — no credential, or an invalid oneapplication/json
Error codes
  • UNAUTHORIZEDNo credential was sent, or the one sent is invalid, expired or revoked
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
401 exampleSynthesized example
{
"error": {
"code": "code-27b3",
"message": "Label every synthesized example"
}
}
403Forbidden — the caller's access level or token scope is insufficientapplication/json
Error codes
  • FORBIDDENYou are signed in but may not do this here; reason names the permission or the rule that refused it
  • INSUFFICIENT_SCOPEThe access token lacks the scope this operation needs; required_scope names it
  • PERMISSION_REQUIREDYou need a permission you do not hold here; the message names it
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
403 exampleSynthesized example
{
"error": {
"code": "code-461a",
"message": "Stream pipeline status into the run header"
}
}
404Release not foundapplication/json
Error codes
  • NOT_FOUNDThe resource does not exist — or exists and you cannot see it: a private resource you have no access to answers exactly as an absent one does
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
404 exampleSynthesized example
{
"error": {
"code": "code-a7bb",
"message": "Pin a page's payload to the build that rendered it"
}
}
409Version conflictapplication/json
Error codes
  • CONFLICTThe request conflicts with the resource's current state; reason says how
  • LEGAL_ACCEPTANCE_REQUIREDAccept the current Terms of Service before changing anything; reading stays open
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
409 exampleSynthesized example
{
"error": {
"code": "code-0c65",
"message": "Pin a page's payload to the build that rendered it"
}
}

CLI

gitmoap releases update

  • --repo-ididRepository ID (id or owner/repo path)
  • --tag-nameidTag name
  • --bodystringoptional
  • --draftflagoptional
  • --namestringoptional
  • --prereleaseflagoptional
  • --versionnumberThe release's `version` as you last read it. The update is refused if the release has changed since.

Used in these guides