Skip to main content
Use the External Accounts API to list connected accounts, connect a profile through OAuth, create a Whop-managed Facebook page or TikTok account, or connect a Klaviyo account with its API key, and disconnect an external account.

​
Endpoints

​
Attributes

​
string
required
Unique identifier for the external account.
​
string | null
required
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.
​
string | null
required
The platform-specific ID for this external account.
​
string | null
required
The display name of the external account on the platform.
​
object | null
required
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.

Properties

​
string
required
External account ID, prefixed sacc_.
​
string | null
required
The platform-specific ID for the parent external account.
​
string | null
required
The display name of the parent external account on the platform.
​
string
required
The platform the parent external account exists on.Available options: x, instagram, youtube, tiktok, facebook, linkedin, snapchat, klaviyo, quickbooks, aimerce
​
string | null
required
The URL where the profile picture of the parent external account can be accessed.
​
string | null
required
The username of the parent external account on the platform.
​
boolean
required
Whether the parent external account is verified on the platform.
​
string | null
required
Always null. Partnership ads are no longer available.
​
string
required
The platform the external account exists on.Available options: x, instagram, youtube, tiktok, facebook, linkedin, snapchat, klaviyo, quickbooks, aimerce
​
string | null
required
The URL where the profile picture of the external account can be accessed.
​
string[]
required
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.
​
string | null
required
The URL where the external account can be accessed on the platform. Null while a Whop-owned account is still being provisioned.
​
string | null
required
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.
​
boolean
required
Whether the external account is verified on the platform.
ExternalAccount