Sign in
Social Accounts

Create a Social Account

Creates or returns a Whop-managed Facebook page or TikTok account for an account.

post/social_accounts

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) to create the social account for. An account-scoped API key may omit this to default to its own account. Account API keys cannot update their own account's branding through Update Account; use a user-authenticated path.

platform'facebook' | 'tiktok' required

The platform to create the social account on. facebook requires the account's banner_image, logo, and description, and tiktok requires its logo; configure them with Update Account. The account is returned before the platform has created it — its id is usable right away, and the rest of the profile fills in once provisioning finishes.

Example request

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "platform": "facebook"
}

Response

social account created

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 10 of the 74 revisions of this API.269

  • 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

  • 7fcefabddb0a2See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

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

  • 5fa504e786951See the full diff
    • ○

      added the new tiktok enum value to the request property

      request-property-enum-value-added

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

  • 4a1a4a5d2c721See the full diff
    • ○

      removed the non-success response with the status

      response-non-success-status-removed

  • 6a23760847c81See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

  • ae20b30817de1See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

  • a01100378e591See the full diff
    • ○

      added the required property to the response with the status

      response-required-property-added

  • f1020c3ecda42See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

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

  • 60bbb4a6ffbc22See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ○

      added the new optional header request parameter Idempotency-Key

      new-optional-request-parameter

    • ○

      added the required property to the response with the status

      response-required-property-added

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

  • 3a06a605784b2See the full diff
    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

Of the 74 revisions, 1 has no diff computed.