Sign in
latestOpenAPI 3.0.42026-08-183012522.1 MB

66dcb6293180

Releases

Update a release

Updates the specified release by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

patch/v3/releases/{id}

Path parameters

idstring required

Unique identifier for the release.

Request body

namestring nullable

Name of the release. This can be a user friendly name to identify the release.

Any printable characters, including letters from any script, punctuation and emoji. Cannot contain line breaks, tabs, other control characters, invisible formatting characters (zero-width and bidirectional marks), and cannot start or end with whitespace.

versionstring nullable

The version of the release. Only following three formats are allowed x.x, x.x.x, x.x.x.x.

channelstring nullable

Channel of the release. The default value is 'stable'.

platformsstring[] nullable

Platforms of the release. It will usually have the following values: windows, linux, macos, win32, win64 etc.

privateboolean nullable

Private releases don't appear in the customer portal.

notesstring nullable

Release notes for the release. It also supports markdown.

Response

OK

idstring required
createdAtstring date-time required
updatedAtstring date-time required
namestring required
channelstring required
versionstring required
platformsstring[] required
notesstring required
totalFilesinteger required
publishedAtstring date-time nullable
publishedboolean required
privateboolean required
archivedboolean required
productIdstring required
tenantIdstring required