Skip to main content
Use the External Accounts API for all new integrations. External account IDs keep their sacc_ prefix, and the underlying resource is unchanged.

Endpoints

Attributes

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

Properties

string
required
Social account ID, prefixed sacc_.
string | null
required
The platform-specific ID for the parent social account.
string | null
required
The display name of the parent social account on the platform.
string
required
The platform the parent social account exists on.Available options: x, instagram, youtube, tiktok, facebook, discord, telegram, linkedin, snapchat, klaviyo, quickbooks, aimerce
string | null
required
The URL where the profile picture of the parent social account can be accessed.
string | null
required
The username of the parent social account on the platform.
boolean
required
Whether the parent social account is verified on the platform.
string | null
required
Always null. Partnership ads are no longer available.
string
required
The platform the social account exists on.Available options: x, instagram, youtube, tiktok, facebook, discord, telegram, linkedin, snapchat, klaviyo, quickbooks, aimerce
string | null
required
The URL where the profile picture of the social account can be accessed.
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.
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.
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.
boolean
required
Whether the social account is verified on the platform.
SocialAccount