Sign in
Social Accounts

Connect a Social Account

Starts an OAuth connection flow and returns an authorize_url where the user can connect a social account. LinkedIn supports personal profiles only, with scopes omitted. TikTok connects the authenticated user’s profile when scopes are omitted or company advertising assets with advertise. Meta Business and Snapchat support advertising connections only and require advertise. Personal profile connections must be completed in a browser signed in as the initiating Whop user.

post/social_accounts/connect

Headers

Idempotency-Keystring
Example:d9105228-4a08-46b1-8b91-42fed586d383

A unique key that makes this request safe to retry. See Idempotent requests.

Request body

account_idstring

The Account (biz_ identifier) to connect the social account for. An account-scoped API key may omit this to default to its own account. Omit for user profile connections.

platform'meta_business' | 'tiktok' | 'linkedin' | 'snapchat' required

The platform to connect the social account on. Use meta_business to connect Meta Business assets, which is how Facebook Pages and Instagram accounts are connected — there is no separate instagram value. Use tiktok for TikTok accounts, snapchat for Snapchat Public Profiles, or linkedin to connect the authenticated user’s LinkedIn profile.

redirect_urlstring required

Where to send the user once they finish connecting their accounts. Any http or https URL. If the connection fails, the user is redirected with a social_account_error query param.

scopesstring[]

The connection purpose. For meta_business and snapchat, advertise is required and connects company advertising assets. For linkedin, omit scopes to connect the authenticated user’s profile; advertising is not supported. For tiktok, omit scopes to connect the authenticated user’s profile, or pass advertise to connect company advertising assets. Profile connections still request the platform permissions needed to read the profile.

Example request

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "platform": "meta_business",
  "redirect_url": "https://example.com/settings/social-accounts",
  "scopes": [
    "advertise"
  ]
}

Response

authorize url returned

authorize_urlstring required

The OAuth authorization URL to redirect the user to.

Example response

{
  "authorize_url": "https://www.facebook.com/v25.0/dialog/oauth"
}

Changes

Changed in 6 of the 74 revisions of this API.17

  • c1dceb26e5051See the full diff
    • ○

      added the new snapchat enum value to the request property

      request-property-enum-value-added

  • 7fcefabddb0a1See the full diff
    • ○

      added the new linkedin enum value to the request property

      request-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4ddae15b5de81See the full diff
    • ▲

      the request property became required

      request-property-became-required

  • ae20b30817de1See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

  • f1020c3ecda42See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 60bbb4a6ffbc2See the full diff
    • ○

      added the new optional header request parameter Idempotency-Key

      new-optional-request-parameter

    • ○

      added the new tiktok enum value to the request property

      request-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.