Skip to main content
POST
Connect social account for team

Authorizations

x-api-key
string
header
required

Body

application/json

Body

type
enum<string>
required
Available options:
TIKTOK,
YOUTUBE,
INSTAGRAM,
FACEBOOK,
TWITTER,
THREADS,
LINKEDIN,
PINTEREST,
REDDIT,
MASTODON,
DISCORD,
SLACK,
BLUESKY,
GOOGLE_BUSINESS,
SNAPCHAT
teamId
string
required
redirectUrl
string<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.

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

tiktokForceLogin
boolean
default:false

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

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

withMessagingScope
boolean
default:false

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

reconnect
boolean
default:false

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

url
string
required

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