Skip to main content
POST
TypeScript

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

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"

Path Parameters

id
string
required

Account ID, prefixed biz_.

Body

application/json
identifier
string
required

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.

Example:

"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.

Example:

true

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
Example:

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

Response

Ownership transferred.

success
boolean
required
Example:

true