Social Accounts

Add Partner

Changed on

Deprecated compatibility endpoint. Add partners with POST /external_accounts/{external_account_id}/partners instead.

post/social_accounts/{id}/partners

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/social_accounts/{id}/partners
  • 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) that advertises as the Instagram account. An account-scoped API key may omit this to default to its own account.

usernamestring required

The creator's Instagram username, with or without the leading @. The creator needs a professional (Business or Creator) Instagram account.

Example request

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "username": "@luverahealth"
}

Response

creator invited through the deprecated path

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.

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 social account isn't a partner.

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

{
  "external_id": "17841479809129315",
  "id": "sacc_xxxxxxxxxxxxxx",
  "name": "Shine Time Detail",
  "parent_social_account": {
    "external_id": "page_1",
    "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/instagram.png",
  "scopes": [
    "advertise"
  ],
  "url": "https://instagram.com/shinetimedetail",
  "username": "shinetimedetail",
  "verified": true
}

Changes

  • 8d734102c0b6Revision changes
    • info

      endpoint deprecated

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

  • 06291fc035edRevision changes
    • info

      endpoint added