git.releases.update

Edit a release, or publish a draft (draft: false)

PATCH /git/api/repositories/{repoId}/releases/{releaseId}IAM git:UpdateReleaseChanges state

Request syntax

PATCH /git/api/repositories/{repoId}/releases/{releaseId}
{
  "name": "string",
  "body": "string",
  "draft": "object",
  "prerelease": "boolean"
}

Path parameters

  • repoIdRequired

    string

    Constraints: uuid

  • releaseIdRequired

    string

    Constraints: uuid

Request body

  • nameOptional

    string

    New title; an empty one resets it to the tag name

    Constraints: max 255 chars

  • bodyOptional

    string

    New release notes (Markdown), replacing the old

    Constraints: max 125000 chars

  • draftOptional

    object

    false publishes a draft (fires published + released/prereleased)

    Constraints: JSON

  • prereleaseOptional

    boolean

    Mark it a pre-release, or not

Response

200 with the release after the change and `runIds`, the workflow runs it started.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Fields of data

  • idAlways

    string

    The release id
  • tagNameAlways

    string

    The tag it publishes, without refs/tags/
  • commitOidAlways

    string

    The commit the tag pointed at when the release was created
  • nameAlways

    string

    The title; the tag name unless one was given
  • bodyAlways

    string

    Release notes (Markdown); empty when none were written
  • draftAlways

    boolean

    A draft is not published yet
  • prereleaseAlways

    boolean

    Marked a pre-release
  • createdAtAlways

    string

    When it was created (ISO 8601)
  • publishedAtAlways

    string, may be null

    When it was published (ISO 8601); null while it is a draft
  • runIdsAlways

    array of string

    Workflow runs the `release` event started; empty when none did

Checked against the handlers: every route test validates their answers against this schema.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow git:UpdateRelease on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud git releases update repoId releaseId

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_git_releases_update.