Archive release

After a published release is archived it is not shown to end users.

POST/v3/releases/{id}/archive

JWT

release:write

Parameters

Name	Type	In	Description
id*	string	path

Triggers webhook: release.archived

POST <your-webhook-url>
{
  "event": "release.archived",
  "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

409

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"
}