---
title: "Update the release notes on an existing Release."
method: POST
path: "/spaces/{spaceIdentifier}/releases/{releaseId}/release-notes"
tags: ["Releases"]
---

# Update the release notes on an existing Release.

`POST /spaces/{spaceIdentifier}/releases/{releaseId}/release-notes`

Only the release notes are changed and everything else about the Release is left alone. Variable expressions in the notes are evaluated before they are stored, so the saved text is the resolved one.

## Path parameters

- `spaceIdentifier` string, required
- `releaseId` string, required

## Request body

- UpdateReleaseNotesCommand — Only the release notes are changed and everything else about the Release is left alone. Variable expressions in the notes are evaluated before they are stored, so the saved text is the resolved one.
  - `ReleaseId` string, required — The ID of the release, for example 'Releases-123'.
  - `ReleaseNotes` string, required — The notes to store, replacing whatever the release currently has. Markdown is supported. Build information is in scope, so expressions such as #{Octopus.Release.WorkItems} and #{Octopus.Release.Number} are resolved before the notes are saved. Send an empty string to clear them.
  - `SpaceId` string, required — The ID of the space containing the resource(s)

## Response `200`

Confirmation that the release notes were updated, containing the updated Release

- ReleaseResource
  - `Assembled` string, date-time
  - `BuildInformation` ReleasePackageVersionBuildInformationResource[]
    - `Branch` string
    - `BuildEnvironment` string
    - `BuildNumber` string
    - `BuildUrl` string
    - `Commits` CommitDetails[]
      - `Comment` string
      - `Id` string
      - `LinkUrl` string
    - `IssueTrackerName` string
    - `PackageId` string
    - `VcsCommitNumber` string
    - `VcsCommitUrl` string
    - `VcsRoot` string
    - `VcsType` string
    - `Version` string
    - `WorkItems` WorkItemLink[]
      - `Description` string
      - `Id` string
      - `LinkUrl` string
      - `Source` string
  - `ChannelId` string
  - `CustomFields` object
  - `Id` string — Gets or sets a unique identifier for this resource.
  - `IgnoreChannelRules` boolean
  - `LastModifiedBy` string — Gets or sets the username of the user who last modified this resource.
  - `LastModifiedOn` string, date-time — Gets or sets the date/time that this resource was last modified.
  - `LibraryVariableSetSnapshotIds` string[] — Snapshots of the project's included library variable sets. The snapshots are VariableSetResources, not LibraryVariableSetResources.
  - `Links` object — Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
  - `ProjectDeploymentProcessSnapshotId` string
  - `ProjectId` string
  - `ProjectVariableSetSnapshotId` string
  - `ReleaseNotes` string
  - `SelectedGitResources` SelectedGitResource[]
    - `ActionName` string, required
    - `GitReferenceResource` GitReferenceResource, required
      - `GitCommit` string
      - `GitRef` string
    - `GitResourceReferenceName` string
  - `SelectedPackages` SelectedPackage[]
    - `ActionName` string
    - `PackageReferenceName` string
    - `StepName` string
    - `Version` string
  - `SpaceId` string
  - `Version` string, required
  - `VersionControlReference` SnapshotGitReferenceResource
    - `GitCommit` string
    - `GitRef` string
    - `VariablesGitCommit` string

## Other responses

- `400` — Bad request. Either the payload was not structurally valid or business rules did not permit the operation.
- `404` — Not found. One or more of the entities involved in the operation was not found.

---

[API](https://skmtc.net/octopus/apis/octopus-server-api.md) · [All operations](https://skmtc.net/octopus/apis/octopus-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/octopus/octopus-server-api/revisions/b296c3a60aa5/schema)