Skip to navigation

Update

Change a launch’s details. Its owners are told what changed, by whom and from what, about ten minutes after the edits stop, in one message that leaves out each owner’s own edits (launchUpdates in their notification preferences). Its artifacts and links count too; its steps do not, and nothing is sent about a draft. 409 launched when draft: true would take a launched launch back to being a draft, and 409 draft when the change would leave a draft LAUNCHED.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

launchIdstringRequired

Request

This endpoint expects an object.
namestringOptional
descriptionstringOptional
keyCustomersstringOptional

The customers this launch is for, or who asked for it. Free text; null clears it.

statusenumOptional
Where a launch sits in its lifecycle.
ownerUserIdslist of stringsOptional

Everybody who owns the launch: members of the workspace, or the request is a 422. Left out on create, whoever is asking (a key’s maker while still a member); on update, left alone.

orgTeamIdslist of stringsOptional
The workspace's teams the launch belongs to. Left out on update, left alone.
pmUserIdstringOptional

One owner, the older form of ownerUserIds; null for none. ownerUserIds wins.

orgTeamIdstringOptional

One team, the older form of orgTeamIds; null for none. orgTeamIds wins.

plannedLaunchDatestringOptional

A published launch keeps one; null is refused unless the launch is still a draft.

actualLaunchDatestringOptional
stakeholderUserIdslist of stringsOptional

Who follows the launch: members of the workspace, or the request is a 422 naming the field. Left out on update, left alone.

launchTemplateIdstringOptional

Another launch template, one that is not archived. Steps it already has stay; generating steps afterwards adds the new template’s that it does not have.

draftbooleanOptional

false publishes a draft, announcing it to its stakeholders and telling the reviewers already named on its steps. true takes a published launch back to being a draft, out of review queues, reminders and the digest until it is published again; refused with 409 launched once it has launched.

generateStepsbooleanOptional

Read only where steps would come: a launch that never had its template’s steps gets them when this request gives it its first planned date or publishes it. Send false to leave them off.

Response

This endpoint returns an object.
idstring
organizationIdstring
namestring
statusenum
Where a launch sits in its lifecycle.
ownerslist of objects
Everybody who owns the launch. They hear about its decisions.
teamslist of objects
The teams the launch belongs to.
draftboolean

Held back until published: nobody has been told about it, its steps are in no review queue, and it cannot be launched. A draft is never LAUNCHED: launching it, adding one as a draft with that status, or setting status to LAUNCHED on it is a 409 draft, unless the same request publishes it with draft: false.

stepsGeneratedboolean
stakeholderslist of objects
stepCountinteger
percentToLaunchinteger

Share of steps that have been approved, excepted or marked N/A.

createdAtdatetime
updatedAtdatetime
descriptionstringOptional
keyCustomersstringOptional
The customers this launch is for, or who asked for it. Free text.
pmobjectOptional

The first of owners, from when a launch had one. Read owners.

pmUserIdstringOptional

The first owner’s id. Read owners.

orgTeamobjectOptional

The first of teams, from when a launch had one. Read teams.

plannedLaunchDatedatetimeOptional
actualLaunchDatedatetimeOptional
healthenumOptional

As its newest update says; null until somebody posts one, and once the launch has launched. See /launches/{launchId}/posts.

Allowed values:
launchTemplateIdstringOptional

The launch template its steps come from. See /launch-templates.

launchTemplateobjectOptional
That template's id and name.
ticketingProjectobjectOptional

The ticketing project it follows, if somebody linked one. See /launches/{launchId}/ticketing-project.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Validation Error
429
Too Many Requests Error