Skip to main content
PATCH
Update a release

Authorizations

Authorization
string
header
required

User PAT (td_pat_) scoped to the target project

Path Parameters

projectId
string
required

The project identifier (e.g. project_abc123). Must match the project associated with your PAT.

releaseId
string
required

Body

application/json

Send only the fields to change. name is optional here.

name
string
required
Maximum string length: 255
description
string
note
string

Rich HTML note.

type
string

Project-configured release type (e.g. release, sprint).

parentReleaseId
string

Nest under a parent release (max 3 levels).

startDate
string

ISO date.

endDate
string

ISO date.

startedAt
string

ISO datetime.

completedAt
string

ISO datetime.

isStarted
boolean
isCompleted
boolean
branch
string
environment
string
linkedIssues
object[]
buildTarget
object

{ platform: web|ios|android|api, version, buildNumber, source, deployUrl }.

testers
string[]

User _ids (must be org members).

Response

Release updated

success
enum<boolean>
Available options:
true
data
object
pagination
object