Sign in

v1

latestOpenAPI 3.1.02026-07-1382036.1 KB
Onboarding

Create or resume an onboarding session

Creates a local-only session until valid contact details identify the lead. A prior lead token may be supplied in the x-onboarding-lead-token header, cookie, or request body. A submitted session can also be resumed from Attio with resumeSessionId.

post/api/onboarding/sessions

Request body

path'prescriber' | 'developer' | 'clinic' | 'enterprise' | 'platform' | 'other'

Public onboarding path id. Prefer /onboard?type={id} for new human links. Legacy /onboard#{id} and /onboard#{id}-{payment_plan_tier} links remain supported.

flowIdstring nullable

Browser-local flow id used before the server issues a session id.

resumeSessionIdstring nullable

Submitted onboarding session id to resume from Attio when no lead token is present.

paymentPlanTierstring nullable

Optional Stripe pricing-plan lookup key to assign to the onboarding session.

emailstring email nullable

Optional email seed for URL-driven onboarding links. Browser /onboard?email= links start a fresh local session unless session is also present.

orgIdstring nullable

Optional prefixed provisioning org id, such as photon:org_..., used to link checkout/provisioning to an existing account.

stripeCustomerIdstring nullable

Optional Stripe customer id seed, such as cus_..., stored as stripe_customer_id when the session is identified.

leadTokenstring

Optional serialized lead token. Prefer the x-onboarding-lead-token header when available.

Response

Current onboarding session state.