Skip to main content
POST
Create portal session by external ID

Authorizations

Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Path Parameters

external_customer_id
string | null
required

Body

application/json
expires_in_minutes
integer
default:60

Duration in minutes until the portal session expires. Defaults to 60. Maximum 180.

Required range: 1 <= x <= 180
invalidate_existing
boolean
default:true

When true (default), creating this session soft-deletes any other active portal sessions for the customer. Set to false to allow concurrent sessions — useful when minting portal links for multiple authenticated end-users at once. The customer's permanent portal link (if any) is never invalidated by this.

Response

Created

id
string
required
customer_id
string
required
created_at
string<date-time>
required
expires_at
string<date-time> | null
required
url
string
required