Create | Taktoria API

{
  "id": "id",
  "organizationId": "organizationId",
  "name": "name",
  "status": "SCOPING",
  "owners": [
    {
      "id": "id",
      "name": "name",
      "email": "email",
      "image": "image"
    },
    {
      "id": "id",
      "name": "name",
      "email": "email",
      "image": "image"
    }
  ],
  "teams": [
    {
      "id": "id",
      "name": "name"
    },
    {
      "id": "id",
      "name": "name"
    }
  ],
  "draft": true,
  "stepsGenerated": true,
  "stakeholders": [
    {
      "id": "id",
      "name": "name",
      "email": "email",
      "image": "image"
    },
    {
      "id": "id",
      "name": "name",
      "email": "email",
      "image": "image"
    }
  ],
  "stepCount": 1,
  "percentToLaunch": 1,
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "description": "description",
  "keyCustomers": "keyCustomers",
  "pm": {
    "id": "id",
    "name": "name",
    "email": "email",
    "image": "image"
  },
  "pmUserId": "pmUserId",
  "orgTeam": {
    "id": "id",
    "name": "name"
  },
  "plannedLaunchDate": "2024-01-15T09:30:00Z",
  "actualLaunchDate": "2024-01-15T09:30:00Z",
  "health": "ON_TRACK",
  "launchTemplateId": "launchTemplateId",
  "launchTemplate": {
    "id": "id",
    "name": "name"
  },
  "ticketingProject": {
    "name": "name",
    "url": "url",
    "system": "LINEAR",
    "statusName": "statusName",
    "statusKind": "BACKLOG",
    "progress": 1.1,
    "completedAt": "2024-01-15T09:30:00Z",
    "syncedAt": "2024-01-15T09:30:00Z",
    "syncError": "syncError"
  }
}

Add a launch. With a plannedLaunchDate it gets its launch template’s steps at once, which is what fills each reviewer’s queue; pass generateSteps: false to leave them off. Pass draft: true to save it without telling anybody. A draft with status: LAUNCHED is 409 draft: publish it, then launch it.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

namestringRequired

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

Required unless draft is true. A launch is published with a date to schedule its steps back from.

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

The launch template to take its steps from: one of the workspace’s that is not archived. Left out, the default.

generateStepsbooleanOptional

Its launch template’s steps come with a planned date: left out or true, a launch created with plannedLaunchDate gets them at once, a draft too (its reviewers hear of them when it is published), and a draft created without one gets them when its date is first set or it is published. false leaves them off.

draftbooleanOptional

Save it as a draft, which announces nothing until it is published. A draft cannot have status: LAUNCHED (409 draft).

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

401

Unauthorized Error

402

Subscription Required Error

403

Forbidden Error

409

Conflict Error

422

Validation Error

429

Too Many Requests Error