onboarding

Update onboarding state

patch/api/onboarding

Request body

walletShownboolean nullable

notifiedOnboardingStep[] nullable

usageReasonstring nullable

integrationsstring[] nullable

otherIntegrationsstring nullable

selectedStoreListingVersionIdstring nullable

agentInputobject nullable

onboardingAgentExecutionIdstring nullable

Response

Successful Response

userIdstring required

completedStepsOnboardingStep[] required

walletShownboolean required

notifiedOnboardingStep[] required

rewardedForOnboardingStep[] required

usageReasonstring nullable required

integrationsstring[] required

otherIntegrationsstring nullable required

selectedStoreListingVersionIdstring nullable required

agentInputobject nullable required

onboardingAgentExecutionIdstring nullable required

agentRunsinteger required

lastRunAtstring date-time nullable required

consecutiveRunDaysinteger required

Changes

Changed in 4 of the 165 revisions of this API.22113

Sep 25, 2026b84a51b9981531See the full diff
- ●
  added the new WORKFLOWS_MOVED enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new WORKFLOWS_MOVED enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new WORKFLOWS_MOVED enum value to the / response property for the response status
  response-property-enum-value-added
- ○
  added the new WORKFLOWS_MOVED enum value to the request property //
  request-property-enum-value-added
Aug 10, 2026c5d87f95485993See the full diff
- ●
  added the new AGENTS_TAB_INTRO enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new AGENTS_TAB_INTRO enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new AGENTS_TAB_INTRO enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new BUILD_TAB_INTRO enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new BUILD_TAB_INTRO enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new BUILD_TAB_INTRO enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new MARKETPLACE_TAB_INTRO enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new MARKETPLACE_TAB_INTRO enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new MARKETPLACE_TAB_INTRO enum value to the / response property for the response status
  response-property-enum-value-added
- ○
  added the new AGENTS_TAB_INTRO enum value to the request property //
  request-property-enum-value-added
- ○
  added the new BUILD_TAB_INTRO enum value to the request property //
  request-property-enum-value-added
- ○
  added the new MARKETPLACE_TAB_INTRO enum value to the request property //
  request-property-enum-value-added
Aug 7, 2026c81533fee655268See the full diff
- ▲
  removed the enum value MARKETPLACE_RUN_AGENT of the request property //
  request-property-enum-value-removed
- ▲
  removed the enum value VISIT_COPILOT of the request property //
  request-property-enum-value-removed
- ●
  added the new LIBRARY_RUN_AGENT enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new LIBRARY_RUN_AGENT enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new LIBRARY_RUN_AGENT enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new ONBOARDING_COMPLETE enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new ONBOARDING_COMPLETE enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new ONBOARDING_COMPLETE enum value to the / response property for the response status
  response-property-enum-value-added
- ○
  added the new LIBRARY_RUN_AGENT enum value to the request property //
  request-property-enum-value-added
- ○
  added the new ONBOARDING_COMPLETE enum value to the request property //
  request-property-enum-value-added
- ○
  removed the MARKETPLACE_RUN_AGENT enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the MARKETPLACE_RUN_AGENT enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the MARKETPLACE_RUN_AGENT enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the VISIT_COPILOT enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the VISIT_COPILOT enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the VISIT_COPILOT enum value from the / response property for the response status
  response-property-enum-value-removed
Aug 5, 2026382041c7ecb231See the full diff
- ●
  added the new CAPABILITY_CARDS enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new CAPABILITY_CARDS enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new CAPABILITY_CARDS enum value to the / response property for the response status
  response-property-enum-value-added
- ○
  added the new CAPABILITY_CARDS enum value to the request property //
  request-property-enum-value-added

Full history