SIsignificant-gravitas
v1
onboarding

Update onboarding state

Changed on
patch/api/onboarding

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Request body

wizardRevisioninteger nullable
wizardUserIdstring nullable
walletShownboolean nullable
notifiedOnboardingStep[] nullable
usageReasonstring nullable
integrationsstring[] nullable
otherIntegrationsstring nullable
selectedStoreListingVersionIdstring nullable
agentInputobject nullable
onboardingAgentExecutionIdstring nullable

Response

Successful Response

userIdstring required
wizardRevisioninteger
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

  • fbd909839dcfRevision changes
    • warning

      added the new CHATS_TIP enum value to the / response property for the response status

    • warning

      added the new CHATS_TIP enum value to the / response property for the response status

    • warning

      added the new CHATS_TIP enum value to the / response property for the response status

    • warning

      added the new COST_TIP enum value to the / response property for the response status

    • warning

      added the new COST_TIP enum value to the / response property for the response status

    • warning

      added the new COST_TIP enum value to the / response property for the response status

    • warning

      added the new EXPERT_TIP enum value to the / response property for the response status

    • warning

      added the new EXPERT_TIP enum value to the / response property for the response status

    • warning

      added the new EXPERT_TIP enum value to the / response property for the response status

    • warning

      added the new FIRST_RUN_TOUR enum value to the / response property for the response status

    • warning

      added the new FIRST_RUN_TOUR enum value to the / response property for the response status

    • warning

      added the new FIRST_RUN_TOUR enum value to the / response property for the response status

    • info

      added the new CHATS_TIP enum value to the request property //

    • info

      added the new COST_TIP enum value to the request property //

    • info

      added the new EXPERT_TIP enum value to the request property //

    • info

      added the new FIRST_RUN_TOUR enum value to the request property //

  • 4b66e30bf35bRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status