Sign in
Swagger 2.02026-08-141,9198883.7 MB

dbbd6d1e3f1c

Releases

Updates the release notes on an existing Release.

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.

post/releases/{releaseId}/release-notes

Path parameters

releaseIdstring required

Id of the release

Request body

ReleaseIdstring required

The ID of the release, for example 'Releases-123'.

ReleaseNotesstring 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.

SpaceIdstring required

Response

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

Assembledstring date-time
ChannelIdstring
CustomFieldsobject
Idstring
IgnoreChannelRulesboolean
LastModifiedBystring
LastModifiedOnstring date-time
LibraryVariableSetSnapshotIdsstring[]
Linksobject
ProjectDeploymentProcessSnapshotIdstring
ProjectIdstring
ProjectVariableSetSnapshotIdstring
ReleaseNotesstring
SpaceIdstring
Versionstring required