Account
updateOnboardingProgress
Update onboarding progress
Mark an onboarding step as complete or dismiss the checklist.
Usage
const result = await api.account.updateOnboardingProgress({
body: {
,
},
});Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| body.step | "project_created" | "database_added" | "connection_tested" | "connection_string_copied" | "first_query_run" | 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
import { PgBeamClient } from "pgbeam";
const client = new PgBeamClient({
token: "pbk_...",
baseUrl: "https://api.pgbeam.com",
});
const result = await client.api.account.updateOnboardingProgress({
body: {
,
},
});Errors
| Status | Description |
|---|---|
| 400 | Invalid request parameters. |
| 401 | Missing or invalid authentication. |
| 403 | Operation not allowed by current plan limits. |
| 404 | Resource not found. |
| 429 | Rate limited. Try again later. |