Edit a release
PUT
/releases/{id}Edits a specific release
Example
Section titled “Example”Use resource IDs from your own project. Keep the API token in your server or CI environment.
import { createConfiguration, ReleasesApi } from '@testcollab/sdk';
const config = createConfiguration(process.env.TESTCOLLAB_TOKEN!);const api = new ReleasesApi(config);
const result = await api.editRelease({ "id": 123, "releasePayload": { "name": "Checkout smoke tests", "status": "planned", "project": 123 }});console.log(result);curl --request PUT \ "https://api.testcollab.io/releases/123?token=$TESTCOLLAB_TOKEN" \ --header 'Content-Type: application/json' \ --data '{ "name": "example", "description": "example", "version_pattern": "example", "status": "planned", "target_date": "example", "release_date": "example", "go_no_go_threshold": { "min_pass_rate": 123, "max_open_defects": 123, "min_evidence_coverage": 123 }, "is_public": true, "project": 123}'Parameters
Section titled “Parameters”| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id |
path | number | Yes | Release ID |
Request body
Section titled “Request body”| Field | Type | Required | Description |
|---|---|---|---|
name |
string | Yes | — |
description |
string | No | — |
version_pattern |
string | No | Optional glob pattern matched against build versions to auto-group builds into this release (). Leading v ignored; * matches any suffix (e.g. 2.14.*). Send an empty string to clear. |
status |
string | Yes | Values: planned, in_progress, ready, shipped, blocked. |
target_date |
string | No | — |
release_date |
string | No | — |
go_no_go_threshold |
Release Go No Go Threshold | No | — |
go_no_go_threshold.min_pass_rate |
number | No | Minimum overall pass rate percentage required for a Go verdict |
go_no_go_threshold.max_open_defects |
number | No | Maximum number of total open defects allowed across all severities |
go_no_go_threshold.min_evidence_coverage |
number | No | Minimum percentage of failed executions that must have attachments |
is_public |
boolean | No | — |
project |
number | Yes | — |
test_plans |
Array of number | No | Array of test plan IDs to associate with this release |
requirements |
Array of number | No | Array of requirement IDs to associate with this release |
Response
Section titled “Response”200 — Updated release
| Field | Type | Required | Description |
|---|---|---|---|
id |
number | Yes | — |
name |
string | Yes | — |
status |
string | Yes | Values: planned, in_progress, ready, shipped, blocked. |
target_date |
string | No | — |
created_at |
string | No | — |
{ "id": 123, "name": "example", "status": "planned", "target_date": "example", "created_at": "example"}Errors
Section titled “Errors”| Status | Meaning |
|---|---|
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not found |
500 |
Internal server error |