BUbundle
socialAccount

Create portal link

Changed on

Simplify connect flow. Create a portal link which can be used to manage connected social accounts directly on bundle.social platform without implementing the logic on your side.

post/api/v1/social-account/create-portal-link

Request

  • Base URL
    https://api.bundle.social
  • URL
    https://api.bundle.social/api/v1/social-account/create-portal-link
  • Auth
    API key in header x-api-key

Request body

teamIdstring required
redirectUrlstring uri
socialAccountTypesstring[] required
serverUrlstring 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.

disableAutoLoginboolean

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

tiktokForceLoginboolean

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

forceBrowserOAuthboolean

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'FACEBOOK' | 'INSTAGRAM'

Instagram only - connection method

withBusinessScopeboolean

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

withMessagingScopeboolean

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).

expiresIninteger

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

logoUrlstring uri
userLogoUrlstring uri
userNamestring
goBackButtonTextstring
hidePoweredByboolean
hideGoBackButtonboolean
hideUserLogoboolean
hideUserNameboolean
hideLanguageSwitcherboolean
showModalOnConnectSuccessboolean
language'en' | 'pl' | 'fr' | 'hi' | 'sv' | 'de' | 'es' | 'it' | 'nl' | 'pt' | 'ru' | 'tr' | 'zh' | 'da' | 'th' | 'ko' | 'he' | 'ar'
maxSocialAccountsConnectednumber

Response

200

urlstring required

Changes

  • fb6e4fbd8d2fRevision changes
    • info

      added the new optional request property

    • info

      added the new ar enum value to the request property

    • info

      added the new da enum value to the request property

    • info

      added the new he enum value to the request property

    • info

      added the new ko enum value to the request property

    • info

      added the new th enum value to the request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status