Skip to main content
POST
Create portal link

Authorizations

x-api-key
string
header
required

Body

application/json

Body

teamId
string
required
socialAccountTypes
enum<string>[]
required
Available options:
TIKTOK,
YOUTUBE,
INSTAGRAM,
FACEBOOK,
TWITTER,
THREADS,
LINKEDIN,
PINTEREST,
REDDIT,
MASTODON,
DISCORD,
SLACK,
BLUESKY,
GOOGLE_BUSINESS,
SNAPCHAT
redirectUrl
string<uri>
serverUrl
string<uri>

Mastodon or Bluesky only. Required for Mastodon (the user's instance, e.g. https://mastodon.social). Optional for Bluesky - omit it to use the default issuer https://bsky.social, or pass a custom PDS/entryway issuer.

disableAutoLogin
boolean
default:false

Optional. If true, portal will request provider-specific anti-auto-login behavior where supported.

tiktokForceLogin
boolean
default:false

Optional and experimental. TikTok only. When true, portal routes TikTok authorization through logout to request a fresh login session.

forceBrowserOAuth
boolean
default:false

Optional. Instagram direct OAuth only. When true, Instagram asks for a fresh login instead of reusing the account logged in on that browser. In the hosted portal it applies only on iPhone/iPad. Staying in the browser on iOS is the default for every connection and needs no flag.

instagramConnectionMethod
enum<string>

Instagram only - connection method

Available options:
FACEBOOK,
INSTAGRAM
withBusinessScope
boolean

Optional. Facebook and Instagram only - when provided, portal skips business scope selection modal for Facebook login paths.

withMessagingScope
boolean

Optional. Facebook and Instagram only - request the Meta messaging (DM) scopes. Ignored unless Instagram and Facebook direct messages are enabled for your organization (available on request).

expiresIn
integer

Time in minutes, after which the link will expire. Minimum 5 minutes, maximum 48 hours.

Required range: 5 <= x <= 2880
logoUrl
string<uri>
userLogoUrl
string<uri>
userName
string
goBackButtonText
string
hidePoweredBy
boolean
hideGoBackButton
boolean
hideUserName
boolean
hideLanguageSwitcher
boolean
showModalOnConnectSuccess
boolean
language
enum<string>
default:en
Available options:
en,
pl,
fr,
hi,
sv,
de,
es,
it,
nl,
pt,
ru,
tr,
zh,
da,
th,
ko,
he,
ar
maxSocialAccountsConnected
number

Response

200

url
string
required