Update

PATCH

/steps/:stepId

PATCH

/api/v1/steps/:stepId

curl -X PATCH https://api.taktoria.com/api/v1/steps/stepId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "id": "id",
  "launchId": "launchId",
  "name": "name",
  "functionalTeamId": "functionalTeamId",
  "whenToUse": "EVERY_TIME",
  "status": "NOT_STARTED",
  "sortOrder": 1,
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "launch": {
    "id": "id",
    "name": "name",
    "status": "SCOPING"
  },
  "templateId": "templateId",
  "functionalTeam": {
    "id": "id",
    "name": "name",
    "slug": "slug"
  },
  "reviewer": {
    "id": "id",
    "name": "name",
    "email": "email",
    "image": "image"
  },
  "reviewerUserId": "reviewerUserId",
  "startDate": "2024-01-15T09:30:00Z",
  "dueDate": "2024-01-15T09:30:00Z",
  "link": "link",
  "notes": "notes",
  "decidedAt": "2024-01-15T09:30:00Z",
  "decisionReason": "decisionReason",
  "lastNudgedAt": "2024-01-15T09:30:00Z"
}

Authentication

AuthorizationBearer

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

Path parameters

stepIdstringRequired

Request

This endpoint expects an object.

namestringOptional

functionalTeamIdstringOptional

whenToUseenumOptional

How required a step is, from its launch template.

Allowed values:

statusenumOptional

The approval bit on a single launch step.

reviewerUserIdstring or nullOptional

Who reviews it, a member of the workspace; anybody else is a 422 naming the field. null takes the reviewer off, leaving the step unassigned. A new reviewer is told, as from the step’s row in the app.

startDatestringOptional

dueDatestringOptional

linkstringOptional

notesstringOptional

decisionReasonstringOptional

Up to 1,000 characters, and only with a decided status. Changing status without one clears the old reason. Given to a decision that stays as it was, it goes in the launch’s activity, as POST /steps/{stepId}/reason does.

Response

This endpoint returns an object.

idstring

launchIdstring

namestring

functionalTeamIdstring

whenToUseenum

How required a step is, from its launch template.

Allowed values:

statusenum

The approval bit on a single launch step.

sortOrderinteger

createdAtdatetime

updatedAtdatetime

launchobjectOptional

templateIdstringOptional

functionalTeamobjectOptional

A functional team, the group that performs one kind of review.

reviewerobjectOptional

A person in a Taktoria organization.

reviewerUserIdstringOptional

Who reviews it, a member of the workspace; anybody else is a 422 naming the field.

startDatedatetimeOptional

dueDatedatetimeOptional

linkstringOptional

Link to the supporting doc for this review.

notesstringOptional

decidedAtdatetimeOptional

decisionReasonstringOptional

Why the reviewer decided as they did, as they wrote it. Only a decided step (APPROVED, DENIED, EXCEPTION or NOT_APPLICABLE) has one; a new decision replaces it.

lastNudgedAtdatetimeOptional

Errors

403

Forbidden Error

404

Not Found Error

422

Validation Error

429

Too Many Requests Error