Create connect session
Creates a hosted onboarding session for a customer-owned social account. Use the returned URL to send the end user into UniPost's managed Connect flow. For OAuth platforms, this endpoint defaults to white-label mode: the workspace must already have platform credentials uploaded unless you explicitly pass allow_quickstart_creds=true. Facebook Page sessions connect the first publishable Page returned by Meta for the authorizing user.
Authorization
AuthorizationBearer <token>In header
Workspace API key.
Request Body
platformstring
Destination platform for the hosted onboarding flow.
Valuestwitter | linkedin | bluesky | youtube | tiktok | instagram | threads | facebook | pinterest
profile_id?string
Profile that should own the resulting connected account. Required when the workspace has multiple profiles.
external_user_idstring
Your stable end-user identifier.
external_user_email?string
Optional email for reconciliation and support.
return_url?string
Where UniPost redirects the user after completion.
allow_quickstart_creds?boolean
Optional escape hatch for OAuth platforms. Defaults to false. When false, the workspace must already have white-label platform credentials uploaded for that platform. Set true only if you intentionally want this session to fall back to UniPost's shared Quickstart OAuth app.
Response Body
201
idstring
Connect session ID.
urlstring
Hosted onboarding URL to redirect the user to.
allow_quickstart_credsboolean
Whether this session is allowed to fall back to UniPost's shared Quickstart OAuth app when no workspace-specific credentials exist.
managed_account_idstring
Present after the session completes. Alias of completed_social_account_id for hosted Connect callers.
statusstring
Session lifecycle state. Create responses start as pending.
Valuespending | completed | expired | cancelled
expires_atstring | null
Expiration timestamp for the hosted session.
401
error.codestring
Usually "UNAUTHORIZED".
error.normalized_codestring
Lowercase alias such as "unauthorized".
error.messagestring
Human-readable error message.
request_idstring
Request identifier for debugging and support.
402
error.codestring
Usually "UNAUTHORIZED".
error.normalized_codestring
Lowercase alias such as "unauthorized".
error.messagestring
Human-readable error message.
request_idstring
Request identifier for debugging and support.
422
error.codestring
Usually "UNAUTHORIZED".
error.normalized_codestring
Lowercase alias such as "unauthorized".
error.messagestring
Human-readable error message.
request_idstring
Request identifier for debugging and support.
500
error.codestring
Usually "UNAUTHORIZED".
error.normalized_codestring
Lowercase alias such as "unauthorized".
error.messagestring
Human-readable error message.
request_idstring
Request identifier for debugging and support.