Skip to main content
POST
Approve onboarding section
CLI:

Overview

Mark an onboarding section as approved by the user. The legacy final approval step completes onboarding without starting legacy scans. This page documents post /api/onboarding/approve-section. Use the request and response sections on this page for accepted parameters, payload fields, response fields, and authentication behavior.

AI agent notes

  • Confirm the operation matches the user’s intent before calling it.
  • For write operations, confirm the user intends to change state.
  • Surface validation, permission, and not-found errors instead of retrying unchanged.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Mark a per-section onboarding draft as approved by the user. Idempotent: re-approving a section is a no-op.

section
enum<string>
required

Which onboarding section the user is approving. signal_config is the legacy final gate: approving it completes onboarding.

Available options:
company,
market,
signals_context,
signal_config
runFirstScan
boolean
default:true
required

Deprecated legacy Signals flag. Accepted for backward compatibility and ignored.

Response

Section approved.

Result of approving an onboarding section.

section
string
required

Echo of the approved section key.

approved
boolean
required

Always true on a 200. The section is approved (whether it was approved by this call or already approved).

onboardingCompleted
boolean
required

true when final signal_config approval has ensured user_profiles.onboarding_completed. false for non-final sections.

signalScanTriggered
boolean
required

Deprecated legacy Signals field. Always false because old scans are no longer triggered from onboarding.