---
title: "PUT /v1/workspaces/{workspaceId}/onboarding/goal"
method: PUT
path: "/v1/workspaces/{workspaceId}/onboarding/goal"
---

# PUT /v1/workspaces/{workspaceId}/onboarding/goal

`PUT /v1/workspaces/{workspaceId}/onboarding/goal`

## Request

- Base URL: `https://api.bangermail.com`
- URL: `https://api.bangermail.com/v1/workspaces/{workspaceId}/onboarding/goal`
- Auth: HTTP bearer

## Request body

- object
  - `goal` 'work_inbox' | 'product_email' | 'campaign' | 'company_workflow', required

## Response `200`

The first outcome is selected and the guided run may open in the product shell.

- object
  - `data` object, required
    - `goal` 'work_inbox' | 'product_email' | 'campaign' | 'company_workflow', required

---

[API](https://skmtc.dev/bangermail/apis/banger-api.md) · [All operations](https://skmtc.dev/bangermail/apis/banger-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bangermail/apis/banger-api/revisions/a149909267f9?raw)
