Skip to content
On this page

Business API

Business profile fields on the authenticated user (ext-business of Onboarding).

There is no separate /auth/user/me/business* route family. Writes go through the existing profile endpoints.

Write / read

CapabilityPath
Update business profilePUT /auth/user/me (is_business, biz_name, biz_country, biz_state, biz_position, biz_postal_code)
Wizard upsert (first run)POST /auth/user/me/onboarding/complete
Read profile (includes biz when installed)GET /auth/user/me

Requires Module Hub onboarding ext-business columns. Missing columns → biz fields ignored or omitted (same graceful behavior as other onboarding extensions).

PUT /auth/user/me rejects acquisition and privacy fields — use complete or Privacy API.

Example

http
PUT /auth/user/me
Content-Type: application/json
X-Session-ID: <session>

{
  "is_business": true,
  "biz_name": "Acme Corp",
  "biz_country": "US",
  "biz_state": "California",
  "biz_position": "CTO",
  "biz_postal_code": "94107"
}

Admin analytics

Admin acquisition analytics, list filters (is_business / biz_country), and related reporting: see Admin API.

Operations