Skip to main content
POST
TypeScript

Yetkilendirmeler

Authorization
string
header
gerekli

An Account API key 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.

Scopes

company:transfer_ownership
partner:handoff

Başlıklar

Idempotency-Key
string

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

Maximum string length: 255
Örnek:

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

Yol Parametreleri

id
string
gerekli

Account ID, prefixed biz_.

Gövde

application/json
identifier
string
gerekli

The user to transfer ownership to: a user ID (user_*) or an email address. An email address with no Whop account yet is sent an invite to create one.

Örnek:

"marcus@shinetime.example"

as_partner
boolean

If true, the current owner is credited as the account's Whop partner, earning partner commission on its sales. Requires the current owner to already be an enrolled Whop partner. Skipped if the account already has an active partner.

Örnek:

true

authorized_user_id
string

Your team membership on the business this referral is made for, prefixed ausr_. The referral then credits that team instead of you personally. Requires as_partner.

Örnek:

"ausr_xxxxxxxxxxxxxx"

member_id
string

Your member record on the business this referral is made for, prefixed mber_, when your role there is held on your member record. Send this or authorized_user_id, not both. Requires as_partner.

Örnek:

"mber_xxxxxxxxxxxxxx"

message
string

A note from the partner, shown as a quote in the invite email and signed with their name. Requires as_partner; sending it on an ordinary transfer is a 400. Omit it and the email sends without a note.

Maximum string length: 500
Örnek:

"Hey — set this up after our call on Tuesday. Ping me anytime."

Yanıt

Ownership transferred.

success
boolean
gerekli
Örnek:

true