RUrunway
checklistItem

Update checklist item

Update a checklist item by ID. Supports both legacy checklist-settings and workflows-aware item templates/items.

put/app/{appId}/checklistItem/{checklistItemId}

Request

  • Base URL
    https://api.runway.team
  • URL
    https://api.runway.team/app/{appId}/checklistItem/{checklistItemId}
  • Auth
    API key in header X-API-Key

Path parameters

appIdstring required

The id of the app

checklistItemIdstring required

The id of the checklist item, approval item or regression testing item being fetched / updated

Request body

titlestring

Title of the checklist item

descriptionstring

Description of the checklist item

approverGroupsUserGroup[]

The list of user groups that can approve this checklist item. Custom groups can be included as well

ownersstring[]

List of user ids allowed to approve item

notifyEnabledboolean

Will send a notification when approval is updated.

Response

A checklist item response

idstring required

The identifier of the checklist item

titlestring required

The title of the checklist item

descriptionstring

The description of the checklist item. Accepts markdown.

approverGroupsUserGroup[] required

The list of user groups that can approve this checklist item. Custom groups can be included as well.

releaseType'all' | 'hotfixOnly' | 'rollbackOnly' | 'allExceptHotfix' required

The type of release this checklist item will appear on

notifyEnabledboolean required

Whether the checklist item will notify on Slack when its status changes

statusesChecklistItemStatusType[] required

The list of possible checklist item status types for this checklist item. A subset of all possible ChecklistItemStatusType values

releaseStepTypestring

The release step that the checklist item appears on. Will be null if the placement of the item is not binary. Can either be of type ReleaseStepType, or a step's Step ID can be sent instead

stepIdunknown
oneOffForVersionstring

If the checklist item only applies for a single release version, this field will contain the version string for that version

placement'stepChecklist' | 'approvals' | 'regressionTesting' required

The placement of a given checklist item

Example response

{
  "title": "Gather new release notes",
  "description": "Contact sully@demo.com on the copywriting team to get new release notes together.",
  "oneOffForVersion": "1.1.0",
  "status": {
    "createdAt": "2022-03-02T01:15:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.