---
title: "Update Onboarding Config"
method: PUT
path: "/api/products/{product_id}/onboarding"
tags: ["products"]
---

# Update Onboarding Config

`PUT /api/products/{product_id}/onboarding`

## Request

- Base URL: `https://api.usecrow.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.usecrow.ai/api/products/{product_id}/onboarding`
- Auth: none declared. Required headers: `authorization`
- TypeScript: <https://skmtc.dev/usecrow/apis/crow-backend-multi-tenant-saas/docs/api/products/:product_id/onboarding/put.ts> (a function with typed inputs; its response is checked against the schema)

Update onboarding agent configuration for a product.

## Path parameters

- `product_id` string, required

## Headers

- `authorization` string, required

## Request body

- UpdateOnboardingRequest
  - `onboarding_enabled` boolean, nullable
  - `onboarding_agent_name` string, nullable
  - `onboarding_system_prompt` string, nullable
  - `onboarding_welcome_message` string, nullable
  - `onboarding_intro_sequence` string[], nullable
  - `onboarding_steps` OnboardingStep[], nullable
    - `text` string, required
    - `tool` string, nullable
    - `tools` string[], nullable
    - `context` string, nullable

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/usecrow/apis/crow-backend-multi-tenant-saas.md) - [All operations](https://skmtc.dev/usecrow/apis/crow-backend-multi-tenant-saas/llms.txt) - [OpenAPI document](https://skmtc.dev/usecrow/apis/crow-backend-multi-tenant-saas/revisions/b2950af46532?raw)