---
title: "Update onboarding state"
method: PATCH
path: "/api/onboarding"
tags: ["v1", "onboarding"]
---

# Update onboarding state

`PATCH /api/onboarding`

## Request body

- UserOnboardingUpdate
  - `walletShown` boolean, nullable
  - `notified` OnboardingStep[], nullable
  - `usageReason` string, nullable
  - `integrations` string[], nullable
  - `otherIntegrations` string, nullable
  - `selectedStoreListingVersionId` string, nullable
  - `agentInput` object, nullable
  - `onboardingAgentExecutionId` string, nullable

## Response `200`

Successful Response

- UserOnboarding
  - `userId` string, required
  - `completedSteps` OnboardingStep[], required
  - `walletShown` boolean, required
  - `notified` OnboardingStep[], required
  - `rewardedFor` OnboardingStep[], required
  - `usageReason` string, nullable, required
  - `integrations` string[], required
  - `otherIntegrations` string, nullable, required
  - `selectedStoreListingVersionId` string, nullable, required
  - `agentInput` object, nullable, required
  - `onboardingAgentExecutionId` string, nullable, required
  - `agentRuns` integer, required
  - `lastRunAt` string, date-time, nullable, required
  - `consecutiveRunDays` integer, required

## Other responses

- `401` — Authentication required
- `422` — Validation Error

---

[API](https://skmtc.net/significant-gravitas/apis/autogpt-agent-server.md) · [All operations](https://skmtc.net/significant-gravitas/apis/autogpt-agent-server/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/significant-gravitas/autogpt-agent-server/versions/382041c7ecb2/schema)