---
title: "UpdateOnboardingProgress"
description: "Update onboarding progress"
canonical: "https://pgbeam.com/docs/go-sdk/account/updateOnboardingProgress"
last-updated: "2026-10-30T13:32:17.000Z"
---

# UpdateOnboardingProgress

> Update onboarding progress

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

{/* Auto-generated from OpenAPI. Do not edit. Run `pnpm generate:sdk-docs` to regenerate. */}

Mark an onboarding step as complete or dismiss the checklist.

## Usage

```go
result, err := client.Account.UpdateOnboardingProgress(ctx, "org_abc123", pgbeam.UpdateOnboardingRequest{})
```

## Parameters

| Parameter    | Type                                  | Required | Description                                      |
| ------------ | ------------------------------------- | -------- | ------------------------------------------------ |
| ctx          | `context.Context`                     | Yes      | Request context                                  |
| orgID        | `string`                              | Yes      | Unique organization identifier.                  |
| body         | `pgbeam.UpdateOnboardingRequest`      | Yes      | Request body                                     |
| body.Step    | `*pgbeam.UpdateOnboardingRequestStep` | No       | The onboarding step to mark as complete.         |
| body.Dismiss | `*bool`                               | No       | Set to true to dismiss the onboarding checklist. |

## Response

`(*pgbeam.OnboardingProgress, error)`: updated onboarding progress.

## Example

```go
import pgbeam "go.pgbeam.com/sdk"

client := pgbeam.NewClient(&pgbeam.ClientOptions{
  APIKey: "pbu_...",
})

step := pgbeam.UpdateOnboardingRequestStep("project_created")
result, err := client.Account.UpdateOnboardingProgress(ctx, "org_abc123", pgbeam.UpdateOnboardingRequest{
    Step: &step,
  })
if err != nil {
  log.Fatal(err)
}
fmt.Println(result)
```

## 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.                                                                                                                                                                                        |