External Account - Whop Docs

An External Account represents a profile on another platform connected to a Whop account or user, such as a Facebook page, Instagram account, or TikTok account. Connecting an external account lets Whop run ads under that profile’s identity and promote its existing posts. External account IDs are prefixed sacc_. Use the External Accounts API to list connected accounts, create a Whop-managed Facebook page, start an OAuth connection, disconnect an external account, and list a connected profile’s posts or a Facebook page’s lead forms.

Endpoints

Endpoint	Request
List External Accounts	GET `/external_accounts`
List External Account Lead Forms	GET `/external_accounts/{id}/lead_forms`
List External Account Partners	GET `/external_accounts/{external_account_id}/partners`
List External Account Posts	GET `/external_accounts/{id}/posts`
Create an External Account	POST `/external_accounts`
Add Partner	POST `/external_accounts/{external_account_id}/partners`
Refresh	POST `/external_accounts/{id}/refresh`
Connect an External Account	POST `/external_accounts/connect`
Delete an External Account	DELETE `/external_accounts/{id}`
Remove Partner	DELETE `/external_accounts/{external_account_id}/partners/{id}`

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

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

Where a partner creator’s permission to run partnership ads stands. pending until the creator approves it in the Instagram app, approved once they have, and revoked once it no longer holds. Null when the external account isn’t a partner.Available options: pending, approved, revoked

string

required

The platform the external account exists on.Available options: x, instagram, youtube, tiktok, facebook, linkedin, snapchat

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.

boolean

required

Whether the external account is verified on the platform.

ExternalAccount

{
	"id": "sacc_xxxxxxxxxxxx",
	"external_id": "17841400000000000",
	"name": "Pickaxe Pro",
	"parent_external_account": {
		"id": "sacc_yyyyyyyyyyyy",
		"platform": "facebook",
		"username": "pickaxepro",
		"name": "Pickaxe Pro",
		"profile_picture_url": "https://img.whop.com/sacc_yyyyyyyyyyyy.png",
		"verified": true,
		"external_id": "112233445566778"
	},
	"platform": "instagram",
	"profile_picture_url": "https://img.whop.com/sacc_xxxxxxxxxxxx.png",
	"scopes": ["advertise"],
	"partnership_status": null,
	"error": null,
	"url": "https://instagram.com/pickaxepro",
	"username": "pickaxepro",
	"verified": true
}

​Endpoints

​Attributes

Endpoints

Attributes