Skip to main content
POST
Refresh

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"

Path Parameters

id
string
required

The external account (a sacc_ identifier) to refresh.

Body

application/json
account_id
string

The Account (biz_ identifier) the external account is connected to. An account-scoped API key may omit this to default to its own account.

Example:

"biz_xxxxxxxxxxxxxx"

Response

refresh started

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

Example:

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

external_id
string | null
required

The platform-specific ID for this external account.

Example:

"1234567891"

id
string
required

Unique identifier for the external account.

Example:

"sacc_xxxxxxxxxxxxxx"

name
string | null
required

The display name of the external account on the platform.

Example:

"Shine Time Auto Detailing"

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

partnership_status
string | null
required

Always null. Partnership ads are no longer available.

Example:

null

platform
enum<string>
required

The platform the external account exists on.

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

"instagram"

profile_picture_url
string | null
required

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

Example:

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

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

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

Example:

"https://instagram.com/shinetimedetail"

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

Example:

"shinetimedetail"

verified
boolean
required

Whether the external account is verified on the platform.

Example:

true