Skip to main content
POST
Add Partner

Authorizations

Authorization
string
header
required

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

Idempotency-Key
string

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

Maximum string length: 255
Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-09-25"

Path Parameters

id
string
required

The Instagram account (a sacc_ identifier) the partners run partnership ads with.

Body

application/json
username
string
required

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

Example:

"@luverahealth"

account_id
string

The Account (biz_ identifier) that advertises as the Instagram account. An account-scoped API key may omit this to default to its own account.

Example:

"biz_xxxxxxxxxxxxxx"

Response

creator invited

error
string | null
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.

Example:

"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
string | null
required

The platform-specific ID for this social account.

Example:

"1234567891"

id
string
required

Unique identifier for the social account.

Example:

"sacc_xxxxxxxxxxxxxx"

name
string | null
required

The display name of the social account on the platform.

Example:

"Shine Time Auto Detailing"

parent_social_account
object | null
required

The social account this one belongs to on the platform, such as the Facebook page that owns an Instagram account. Null when the social account stands on its own, or when it is a partner.

partnership_status
enum<string> | null
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.

Available options:
null,
pending,
approved,
revoked
Example:

"pending"

platform
enum<string>
required

The platform the social account exists on.

Available options:
x,
instagram,
youtube,
tiktok,
facebook,
discord,
telegram,
linkedin,
snapchat
Example:

"instagram"

profile_picture_url
string | null
required

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

Example:

"https://shinetime.example/logo.png"

scopes
string[]
required

Capabilities Whop retains specific to this social account. For example, Whop may request the ability to run advertisements that use this social account's identity, reflected by advertise. Personal profile connections have no additional Whop scopes.

url
string | null
required

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

Example:

"https://instagram.com/shinetimedetail"

username
string | null
required

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

Example:

"shinetimedetail"

verified
boolean
required

Whether the social account is verified on the platform.

Example:

true