Sign in
External Accounts

Refresh

Changed on

Refreshes the state of an external account. Use it to clear an error that has been resolved.

post/external_accounts/{id}/refresh

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/external_accounts/{id}/refresh
  • Auth: HTTP bearer

Headers

Idempotency-Keystring
Example:d9105228-4a08-46b1-8b91-42fed586d383

A unique key that makes this request safe to retry. See Idempotent requests.

Request body

account_idstring

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 request

{
  "account_id": "biz_xxxxxxxxxxxxxx"
}

Response

refresh started

errorstring nullable 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.

external_idstring nullable required

The platform-specific ID for this external account.

idstring required

Unique identifier for the external account.

namestring nullable required

The display name of the external account on the platform.

partnership_status'null' | 'pending' | 'approved' | 'revoked' nullable 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.

platform'x' | 'instagram' | 'youtube' | 'tiktok' | 'facebook' | 'linkedin' | 'snapchat' required

The platform the external account exists on.

profile_picture_urlstring nullable required

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

scopesstring[] required
urlstring nullable required

The URL where the external account can be accessed on the platform. Null while a Whop-owned account is still being provisioned.

usernamestring nullable required

The username of the external account on the platform. Null while a Whop-owned account is still being provisioned.

verifiedboolean required

Whether the external account is verified on the platform.

Example response

{
  "error": "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.",
  "external_id": "1234567891",
  "id": "sacc_xxxxxxxxxxxxxx",
  "name": "Shine Time Auto Detailing",
  "parent_external_account": {
    "external_id": "555111",
    "id": "sacc_xxxxxxxxxxxxxx",
    "name": "Shine Time Auto Detailing",
    "platform": "facebook",
    "profile_picture_url": "https://shinetime.example/logo.png",
    "username": "shinetimedetailing",
    "verified": true
  },
  "partnership_status": "pending",
  "platform": "instagram",
  "profile_picture_url": "https://shinetime.example/logo.png",
  "scopes": [
    "advertise"
  ],
  "url": "https://instagram.com/shinetimedetail",
  "username": "shinetimedetail",
  "verified": true
}

Changes