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}

JWT

release:write

Parameters

Name	Type	In	Description
id*	string	path	Unique identifier for the release.

Request Body Schema

Property	Type	Description	Constraints
name	string	Name of the release. This can be a user friendly name to identify the release.	min: 1, max: 256
version	string	The version of the release. Only following three formats are allowed x.x, x.x.x, x.x.x.x.
channel	string	Channel of the release. The default value is 'stable'.	min: 1, max: 256
platforms	array	Platforms of the release. It will usually have the following values: windows, linux, macos, win32, win64 etc.	items: string
private	boolean	Private releases don't appear in the customer portal.
notes	string	Release notes for the release. It also supports markdown.	min: 0, max: 4096

Request Example

{
  "name": "string",
  "version": "string",
  "channel": "string",
  "platforms": [
    "string"
  ],
  "private": true,
  "notes": "string"
}

Triggers webhook: release.updated

POST <your-webhook-url>
{
  "event": "release.updated",
  "data": {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "channel": "string",
    "version": "string",
    "platforms": [
      "string"
    ],
    "notes": "string",
    "totalFiles": 0,
    "publishedAt": "2019-08-24T14:15:22Z",
    "files": [
      {
        "id": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "name": "string",
        "url": "string",
        "size": 0,
        "downloads": 0,
        "extension": "string",
        "checksum": "string",
        "secured": true,
        "published": true,
        "releaseId": "string",
        "releaseName": "string"
      }
    ],
    "published": true,
    "private": true,
    "archived": true,
    "productId": "string",
    "tenantId": "string"
  },
  "triggeredAt": "string"
}

Responses

200

400

401

403

404

429

500

200 OK

{
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "channel": "string",
  "version": "string",
  "platforms": [
    "string"
  ],
  "notes": "string",
  "totalFiles": 0,
  "publishedAt": "2019-08-24T14:15:22Z",
  "files": [
    {
      "id": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "url": "string",
      "size": 0,
      "downloads": 0,
      "extension": "string",
      "checksum": "string",
      "secured": true,
      "published": true,
      "releaseId": "string",
      "releaseName": "string"
    }
  ],
  "published": true,
  "private": true,
  "archived": true,
  "productId": "string",
  "tenantId": "string"
}