---
title: "PATCH /api/onboarding/deployments/{deploymentId}/checklist"
method: PATCH
path: "/api/onboarding/deployments/{deploymentId}/checklist"
tags: ["ChecklistService"]
---

# PATCH /api/onboarding/deployments/{deploymentId}/checklist

`PATCH /api/onboarding/deployments/{deploymentId}/checklist`

## Path parameters

- `deploymentId` string, required

## Request body

- ProtosOnboardingV1PatchChecklistRequest
  - `deploymentId` string
  - `taskStatus` ProtosOnboardingV1OnboardingTask[]
    - `type` 'TASK_TYPE_COMPLETE_TOUR' | 'TASK_TYPE_SCAN_CODE' | 'TASK_TYPE_TRIAGE_FIRST_PARTY' | 'TASK_TYPE_TRIAGE_DEPENDENCY' | 'TASK_TYPE_SET_UP_RECURRING_SCAN' | 'TASK_TYPE_CONFIGURE_IGNORES' | 'TASK_TYPE_JOIN_SLACK' | 'TASK_TYPE_CUSTOMIZE_RULES' | 'TASK_TYPE_ENABLE_INTEGRATION' | 'TASK_TYPE_ADD_TEAM_MEMBER' | 'TASK_TYPE_WRITE_CUSTOM_RULE' | 'TASK_TYPE_SETUP_SCM_PROVIDER' | 'TASK_TYPE_ENABLE_ASSISTANT' | 'TASK_TYPE_ENABLE_SEMGREP_MULTIMODAL', enum — | value | description | |-------|---------------| | TASK_TYPE_COMPLETE_TOUR | | | TASK_TYPE_SCAN_CODE | | | TASK_TYPE_TRIAGE_FIRST_PARTY | | | TASK_TYPE_TRIAGE_DEPENDENCY | | | TASK_TYPE_SET_UP_RECURRING_SCAN | | | TASK_TYPE_CONFIGURE_IGNORES | | | TASK_TYPE_JOIN_SLACK | | | TASK_TYPE_CUSTOMIZE_RULES | | | TASK_TYPE_ENABLE_INTEGRATION | | | TASK_TYPE_ADD_TEAM_MEMBER | | | TASK_TYPE_WRITE_CUSTOM_RULE | | | TASK_TYPE_SETUP_SCM_PROVIDER | | | TASK_TYPE_ENABLE_ASSISTANT | | | TASK_TYPE_ENABLE_SEMGREP_MULTIMODAL | |
    - `state` 'TASK_STATE_COMPLETE' | 'TASK_STATE_INCOMPLETE' | 'TASK_STATE_LOCKED', enum — | value | description | |-------|---------------| | TASK_STATE_COMPLETE | | | TASK_STATE_INCOMPLETE | | | TASK_STATE_LOCKED | |
    - `level` 'TASK_LEVEL_ORG' | 'TASK_LEVEL_USER', enum — | value | description | |-------|---------------| | TASK_LEVEL_ORG | | | TASK_LEVEL_USER | |

## Response `200`

OK

- ProtosOnboardingV1PatchChecklistResponse
  - `taskStatus` ProtosOnboardingV1OnboardingTask[]
    - `type` 'TASK_TYPE_COMPLETE_TOUR' | 'TASK_TYPE_SCAN_CODE' | 'TASK_TYPE_TRIAGE_FIRST_PARTY' | 'TASK_TYPE_TRIAGE_DEPENDENCY' | 'TASK_TYPE_SET_UP_RECURRING_SCAN' | 'TASK_TYPE_CONFIGURE_IGNORES' | 'TASK_TYPE_JOIN_SLACK' | 'TASK_TYPE_CUSTOMIZE_RULES' | 'TASK_TYPE_ENABLE_INTEGRATION' | 'TASK_TYPE_ADD_TEAM_MEMBER' | 'TASK_TYPE_WRITE_CUSTOM_RULE' | 'TASK_TYPE_SETUP_SCM_PROVIDER' | 'TASK_TYPE_ENABLE_ASSISTANT' | 'TASK_TYPE_ENABLE_SEMGREP_MULTIMODAL', enum — | value | description | |-------|---------------| | TASK_TYPE_COMPLETE_TOUR | | | TASK_TYPE_SCAN_CODE | | | TASK_TYPE_TRIAGE_FIRST_PARTY | | | TASK_TYPE_TRIAGE_DEPENDENCY | | | TASK_TYPE_SET_UP_RECURRING_SCAN | | | TASK_TYPE_CONFIGURE_IGNORES | | | TASK_TYPE_JOIN_SLACK | | | TASK_TYPE_CUSTOMIZE_RULES | | | TASK_TYPE_ENABLE_INTEGRATION | | | TASK_TYPE_ADD_TEAM_MEMBER | | | TASK_TYPE_WRITE_CUSTOM_RULE | | | TASK_TYPE_SETUP_SCM_PROVIDER | | | TASK_TYPE_ENABLE_ASSISTANT | | | TASK_TYPE_ENABLE_SEMGREP_MULTIMODAL | |
    - `state` 'TASK_STATE_COMPLETE' | 'TASK_STATE_INCOMPLETE' | 'TASK_STATE_LOCKED', enum — | value | description | |-------|---------------| | TASK_STATE_COMPLETE | | | TASK_STATE_INCOMPLETE | | | TASK_STATE_LOCKED | |
    - `level` 'TASK_LEVEL_ORG' | 'TASK_LEVEL_USER', enum — | value | description | |-------|---------------| | TASK_LEVEL_ORG | | | TASK_LEVEL_USER | |

---

[API](https://skmtc.net/semgrep/apis/semgrep-web-app.md) · [All operations](https://skmtc.net/semgrep/apis/semgrep-web-app/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/semgrep/semgrep-web-app/revisions/6483eeecd582/schema)