Update the onboarding record for a user

PATCH /onboarding/{userId}

Parameters

userId string Required path

The unique ID of a user. Same as the id field returned by GET /users/me (or by any list endpoint under /users). Log in first, call /users/me, copy id.

x-tenant-id string Required header

Tenant identifier. Required on all tenant-scoped routes.

More parameters Expand all

userId string

The unique ID of a user. Same as the id field returned by GET /users/me (or by any list endpoint under /users). Log in first, call /users/me, copy id.

type enum

No description.

Possible values: personentity

submissionCompleted boolean

No description.

currentStep number

No description.

onboardingData array of objects

No description.

curl -X PATCH "https://heimdall.qa.zoniqx.com/onboarding/<userId>" \ -H "Authorization: Bearer <accessToken>" \ -H "x-tenant-id: <your-tenant-id>" \ -H "Content-Type: application/json" \ -d '{ "userId": "string", "type": "person", "submissionCompleted": false, "currentStep": 1, "onboardingData": [] }'

const response = await fetch("https://heimdall.qa.zoniqx.com/onboarding/<userId>", { method: "PATCH", headers: { "Authorization": "Bearer <accessToken>", "x-tenant-id": "<your-tenant-id>", "Content-Type": "application/json", }, body: JSON.stringify({ "userId": "string", "type": "person", "submissionCompleted": false, "currentStep": 1, "onboardingData": [] }), }); const data = await response.json();

type OnboardingController_updateOnboardingResponse = Record<string, unknown>; const response = await fetch("https://heimdall.qa.zoniqx.com/onboarding/<userId>", { method: "PATCH", headers: { Authorization: "Bearer <accessToken>", "x-tenant-id": "<your-tenant-id>", "Content-Type": "application/json", }, body: JSON.stringify({ "userId": "string", "type": "person", "submissionCompleted": false, "currentStep": 1, "onboardingData": [] }), }); const data: OnboardingController_updateOnboardingResponse = await response.json();

import requests url = "https://heimdall.qa.zoniqx.com/onboarding/<userId>" headers = { "Authorization": "Bearer <accessToken>", "x-tenant-id": "<your-tenant-id>", } payload = { "userId": "string", "type": "person", "submissionCompleted": False, "currentStep": 1, "onboardingData": [] } response = requests.patch(url, headers=headers, json=payload) data = response.json()