Sign in
Social Accounts

Refresh

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

post/social_accounts/{id}/refresh

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 social 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 social 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 social account.

idstring required

Unique identifier for the social account.

namestring nullable required

The display name of the social account on the platform.

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

The platform the social account exists on.

profile_picture_urlstring nullable required

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

scopesstring[] required
urlstring nullable required

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

usernamestring nullable required

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

verifiedboolean required

Whether the social 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_social_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
  },
  "platform": "instagram",
  "profile_picture_url": "https://shinetime.example/logo.png",
  "scopes": [
    "advertise"
  ],
  "url": "https://instagram.com/shinetimedetail",
  "username": "shinetimedetail",
  "verified": true
}

Changes

Changed in 2 of the 74 revisions of this API.21

  • c1dceb26e5052See the full diff
    • ●

      added the new snapchat enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new snapchat enum value to the response property for the response status

      response-property-enum-value-added

  • 7fcefabddb0a1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.