Skip to navigation

Press To Launch

The big red button. Returns 409 when a step marked “Every time” has not been approved, excepted or marked N/A. Pass force to override. A draft is refused with 409 whatever force says: publish it first.

Authentication

AuthorizationBearer

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

Path parameters

launchIdstringRequired

Request

This endpoint expects an object.
forcebooleanOptional
Launch even though required steps are unresolved.
actualLaunchDatestringOptional
Defaults to now.

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

403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error