Refresh
Refreshes the state of an external account. Use it to clear an error that has been resolved.
Authorizations
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
A unique key that makes this request safe to retry. See Idempotent requests.
255"d9105228-4a08-46b1-8b91-42fed586d383"
Pins the request to a dated API version.
"2026-10-06"
Path Parameters
The external account (a sacc_ identifier) to refresh.
Body
The Account (biz_ identifier) the external account is connected to. An account-scoped API key may omit this to default to its own account.
"biz_xxxxxxxxxxxxxx"
Response
refresh started
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.
"You don't have permission to share this account. Ask an admin of its Meta Business Portfolio to grant you full control, then share it again."
The platform-specific ID for this external account.
"1234567891"
Unique identifier for the external account.
"sacc_xxxxxxxxxxxxxx"
The display name of the external account on the platform.
"Shine Time Auto Detailing"
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.
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.
null, pending, approved, revoked "pending"
The platform the external account exists on.
x, instagram, youtube, tiktok, facebook, linkedin, snapchat "instagram"
The URL where the profile picture of the external account can be accessed.
"https://shinetime.example/logo.png"
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.
The URL where the external account can be accessed on the platform. Null while a Whop-owned account is still being provisioned.
"https://instagram.com/shinetimedetail"
The username of the external account on the platform. Null while a Whop-owned account is still being provisioned.
"shinetimedetail"
Whether the external account is verified on the platform.
true

