---
title: "Update"
method: POST
path: "/api/v1/settings/onboarding"
tags: ["Onboarding Settings"]
---

# Update

`POST /api/v1/settings/onboarding`

Update modifies the onboarding progress, such as marking steps complete or dismissing the wizard.

## Request body

- C1ApiSettingsV1UpdateOnboardingSettingsRequest — The UpdateOnboardingSettingsRequest message.
  - `conversationId` string — The identifier of the onboarding conversation thread to associate.
  - `mcpOnboardingGoal` string, nullable — The admin's AIAM onboarding goal. Omit to leave unchanged; set to "" to clear.
  - `mcpOnboardingStatus` 'MCP_ONBOARDING_STATUS_UNSPECIFIED' | 'MCP_ONBOARDING_STATUS_NOT_STARTED' | 'MCP_ONBOARDING_STATUS_IN_PROGRESS' | 'MCP_ONBOARDING_STATUS_COMPLETE' | 'MCP_ONBOARDING_STATUS_DISMISSED', nullable — The new MCP onboarding status to set. Omit (or UNSPECIFIED) to leave it unchanged. Setting NOT_STARTED restarts the briefing and clears the stored mcp_onboarding_goal and mcp_onboarding_targets, unless this same request also sets them (those win).
  - `mcpOnboardingTargets` C1ApiSettingsV1McpOnboardingTargetList — McpOnboardingTargetList wraps the target list so an update can distinguish replace (present, even if empty) from leave-unchanged (omitted).
    - `targets` C1ApiSettingsV1McpOnboardingTarget[], nullable — The targets field.
      - `displayName` string — Snapshot of the human label at selection time.
      - `id` string — Identifies the target within the id space named by kind.
      - `kind` 'MCP_ONBOARDING_TARGET_KIND_UNSPECIFIED' | 'MCP_ONBOARDING_TARGET_KIND_APP' | 'MCP_ONBOARDING_TARGET_KIND_CATALOG_ENTRY' | 'MCP_ONBOARDING_TARGET_KIND_MCP_SERVER' — The kind field.
      - `mcpServerId` string — The registered MCP server a CATALOG_ENTRY target became, once registered.
      - `status` 'MCP_ONBOARDING_TARGET_STATUS_UNSPECIFIED' | 'MCP_ONBOARDING_TARGET_STATUS_PENDING' | 'MCP_ONBOARDING_TARGET_STATUS_DONE' | 'MCP_ONBOARDING_TARGET_STATUS_SKIPPED' — The status field.
  - `status` 'ONBOARDING_STATUS_UNSPECIFIED' | 'ONBOARDING_STATUS_NOT_STARTED' | 'ONBOARDING_STATUS_IN_PROGRESS' | 'ONBOARDING_STATUS_COMPLETE' | 'ONBOARDING_STATUS_DISMISSED' — The new onboarding status to set. UNSPECIFIED leaves the core onboarding status unchanged (set mcp_onboarding_status alone to retire the AIAM briefing without touching the core wizard).

## Response `200`

Successful response

- C1ApiSettingsV1UpdateOnboardingSettingsResponse — The UpdateOnboardingSettingsResponse message.
  - `mcpOnboardingGoal` string — The updated AIAM onboarding goal.
  - `mcpOnboardingStatus` 'MCP_ONBOARDING_STATUS_UNSPECIFIED' | 'MCP_ONBOARDING_STATUS_NOT_STARTED' | 'MCP_ONBOARDING_STATUS_IN_PROGRESS' | 'MCP_ONBOARDING_STATUS_COMPLETE' | 'MCP_ONBOARDING_STATUS_DISMISSED' — The updated AIAM MCP onboarding status.
  - `mcpOnboardingTargets` C1ApiSettingsV1McpOnboardingTarget[], nullable — The updated AIAM onboarding targets.
    - `displayName` string — Snapshot of the human label at selection time.
    - `id` string — Identifies the target within the id space named by kind.
    - `kind` 'MCP_ONBOARDING_TARGET_KIND_UNSPECIFIED' | 'MCP_ONBOARDING_TARGET_KIND_APP' | 'MCP_ONBOARDING_TARGET_KIND_CATALOG_ENTRY' | 'MCP_ONBOARDING_TARGET_KIND_MCP_SERVER' — The kind field.
    - `mcpServerId` string — The registered MCP server a CATALOG_ENTRY target became, once registered.
    - `status` 'MCP_ONBOARDING_TARGET_STATUS_UNSPECIFIED' | 'MCP_ONBOARDING_TARGET_STATUS_PENDING' | 'MCP_ONBOARDING_TARGET_STATUS_DONE' | 'MCP_ONBOARDING_TARGET_STATUS_SKIPPED' — The status field.
  - `status` 'ONBOARDING_STATUS_UNSPECIFIED' | 'ONBOARDING_STATUS_NOT_STARTED' | 'ONBOARDING_STATUS_IN_PROGRESS' | 'ONBOARDING_STATUS_COMPLETE' | 'ONBOARDING_STATUS_DISMISSED' — The updated onboarding status.

---

[API](https://skmtc.net/conductorone/apis/c1-api.md) · [All operations](https://skmtc.net/conductorone/apis/c1-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/conductorone/c1-api/revisions/f2cf3228f366/schema)