BUbundle
socialAccount

Connect social account for team

Changed on

Generate OAuth URL for social account connection. Redirect user to this URL to connect social account. For Mastodon and Bluesky an unusable serverUrl returns 400 with the reason, while a reachable-but-failing instance returns 502.

post/api/v1/social-account/connect

Request

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

Request body

type'TIKTOK' | 'YOUTUBE' | 'INSTAGRAM' | 'FACEBOOK' | 'TWITTER' | 'THREADS' | 'LINKEDIN' | 'PINTEREST' | 'REDDIT' | 'MASTODON' | 'DISCORD' | 'SLACK' | 'BLUESKY' | 'GOOGLE_BUSINESS' | 'SNAPCHAT' required
teamIdstring required
redirectUrlstring uri required

Client-provided return URL. After the OAuth flow completes (success or error), the user will be redirected here with success/error query params appended. Must be a well-formed http/https URL.

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. When true, adds provider-specific flags to avoid automatic login/auto-approval where supported.

tiktokForceLoginboolean

Optional and experimental. TikTok only. When true, routes authorization through TikTok 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

Facebook and Instagram: include business_management, ads_management, ads_read scopes. YouTube: include the monetary analytics scope (enables revenue/monetization data).

withMessagingScopeboolean

Facebook and Instagram: include the Meta messaging (DM) scopes. Ignored unless messaging is enabled for your organization.

reconnectboolean

Re-authorize the account already connected to this team in place: tokens and permissions are refreshed while the account, its posts and scheduled destinations stay. The user must log in with the same account. Currently supported for Instagram connected with instagramConnectionMethod INSTAGRAM.

Response

200

urlstring required

OAuth URL - Redirect user to this URL to connect social account

Changes

  • fb6e4fbd8d2fRevision changes
    • info

      added the new optional request property

    • info

      added the new optional 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