Skip to main content
POST
Create an External Account

Yetkilendirmeler

Authorization
string
header
gerekli

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.

Scopes

social_account:create

Başlıklar

Idempotency-Key
string

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

Maximum string length: 255
Örnek:

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

Api-Version-Date
string

Pins the request to a dated API version.

Örnek:

"2026-11-17"

Gövde

application/json

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

platform
enum<string>
gerekli

The platform to create the external account on.

Mevcut seçenekler:
facebook
Örnek:

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

Örnek:

"biz_xxxxxxxxxxxxxx"

Yanıt

external account created

error
string | null
gerekli

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

Örnek:

"You don't have permission to share this account with Whop. Contact Whop support for help."

external_id
string | null
gerekli

The platform-specific ID for this external account.

Örnek:

"1234567891"

id
string
gerekli

Unique identifier for the external account.

Örnek:

"sacc_xxxxxxxxxxxxxx"

name
string | null
gerekli

The display name of the external account on the platform.

Örnek:

"Shine Time Auto Detailing"

parent_external_account
object | null
gerekli

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

partnership_status
string | null
gerekli

Always null. Partnership ads are no longer available.

Örnek:

null

platform
enum<string>
gerekli

The platform the external account exists on.

Mevcut seçenekler:
x,
instagram,
youtube,
tiktok,
facebook,
linkedin,
snapchat,
klaviyo,
quickbooks,
aimerce
Örnek:

"instagram"

profile_picture_url
string | null
gerekli

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

Örnek:

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

scopes
string[]
gerekli

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

url
string | null
gerekli

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

Örnek:

"https://instagram.com/shinetimedetail"

username
string | null
gerekli

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

Örnek:

"shinetimedetail"

verified
boolean
gerekli

Whether the external account is verified on the platform.

Örnek:

true