---
title: "updateOnboardingProgress"
description: "Update onboarding progress"
canonical: "https://pgbeam.com/docs/ts-sdk/account/updateOnboardingProgress"
last-updated: "2026-09-14T19:37:21.000Z"
---

# updateOnboardingProgress

> Update onboarding progress

URL: https://pgbeam.com/docs/ts-sdk/account/updateOnboardingProgress

Mark an onboarding step as complete or dismiss the checklist.

## Usage

## Parameters

Parameter

Type

Required

Description

pathParams.org\_id

`string`

Yes

Unique organization identifier.

body.step

`"project_created" \| "database_added" \| "connection_tested" \| "connection_string_copied" \| "first_query_run" \| "agent_credential_created"`

No

The onboarding step to mark as complete.

body.dismiss

`boolean`

No

Set to true to dismiss the onboarding checklist.

## Response

`Promise<OnboardingProgress>`: updated onboarding progress.

## Example

## Errors

Status

Description

400

The request was rejected. `code` is `INVALID_INPUT`, and `errors` names the offending fields when the failure was a validation one.

401

Missing or invalid authentication. `code` is `UNAUTHORIZED`.

403

The caller is authenticated but not allowed to perform this operation. `code` is `FORBIDDEN` when the caller's role is insufficient, and `PLAN_LIMIT_REACHED` when the organization's plan is what stands in the way. The two are answered differently, so branch on the code rather than the status.

404

The resource does not exist, or the caller is not entitled to know that it does. `code` is `NOT_FOUND`.

413

The request body exceeds the 2 MB limit. `code` is `PAYLOAD_TOO_LARGE`.

415

The request body is not JSON, or carries a body without declaring a Content-Type. `code` is `UNSUPPORTED_MEDIA_TYPE`.

429

Rate limited. `code` is `RATE_LIMITED`.

500

The request failed for a reason on our side. `code` is `INTERNAL_ERROR`. Quote `request_id` when reporting it.