Skip to main content
POST
TypeScript

Authorizations

Authorization
string
header
required

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Idempotency-Key
string

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

Maximum string length: 255
Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-11-04-1"

Body

application/json

Whop no longer creates Facebook pages, so this returns a facebook_page_provisioning_retired error.

platform
enum<string>
required

The platform to create the external account on.

Available options:
facebook
Example:

"facebook"

account_id
string

The Account (biz_ identifier) to create the external account for. An account-scoped API key may omit this to default to its own account. Account API keys cannot update their own account's branding through Update Account; use a user-authenticated path.

Example:

"biz_xxxxxxxxxxxxxx"

Response

social account created through the deprecated path

error
string | null
required

Why this social account currently can't be used for advertising — a failed share or a Meta-side restriction. Null when the account is healthy.

Example:

null

external_id
string | null
required

The platform-specific ID for this social account.

Example:

"17841479809129315"

id
string
required

Unique identifier for the social account.

Example:

"sacc_xxxxxxxxxxxxxx"

name
string | null
required

The display name of the social account on the platform.

Example:

"Shine Time Detail"

parent_social_account
object | null
required

The social account this one belongs to on the platform, such as the Facebook page that owns an Instagram account. Null when the social account stands on its own, or when it is a partner.

partnership_status
string | null
required

Always null. Partnership ads are no longer available.

Example:

null

platform
enum<string>
required

The platform the social account exists on.

Available options:
x,
instagram,
youtube,
tiktok,
facebook,
discord,
telegram,
linkedin,
snapchat,
klaviyo,
quickbooks,
aimerce
Example:

"instagram"

profile_picture_url
string | null
required

The URL where the profile picture of the social account can be accessed.

Example:

"https://shinetime.example/instagram.png"

scopes
string[]
required

Capabilities Whop retains specific to this social account. For example, Whop may request the ability to run advertisements that use this social account's identity, reflected by advertise. Personal profile connections have no additional Whop scopes.

url
string | null
required

The URL where the social account can be accessed on the platform. Null while a Whop-owned account is still being provisioned.

Example:

"https://instagram.com/shinetimedetail"

username
string | null
required

The username of the social account on the platform. Null while a Whop-owned account is still being provisioned, and on platforms without usernames, such as Klaviyo.

Example:

"shinetimedetail"

verified
boolean
required

Whether the social account is verified on the platform.

Example:

true