Create a Partner Referral Request

Create a partner referral request

curl --request POST \
  --url https://api.whop.com/api/v1/partner_referral_requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "authorized_user_id": "<string>",
  "member_id": "<string>"
}
'

import requests

url = "https://api.whop.com/api/v1/partner_referral_requests"

payload = {
    "account_id": "biz_xxxxxxxxxxxxxx",
    "authorized_user_id": "<string>",
    "member_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    account_id: 'biz_xxxxxxxxxxxxxx',
    authorized_user_id: '<string>',
    member_id: '<string>'
  })
};

fetch('https://api.whop.com/api/v1/partner_referral_requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/partner_referral_requests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account_id' => 'biz_xxxxxxxxxxxxxx',
    'authorized_user_id' => '<string>',
    'member_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/partner_referral_requests"

	payload := strings.NewReader("{\n  \"account_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"authorized_user_id\": \"<string>\",\n  \"member_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.whop.com/api/v1/partner_referral_requests")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"authorized_user_id\": \"<string>\",\n  \"member_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/partner_referral_requests")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"authorized_user_id\": \"<string>\",\n  \"member_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "account": {
    "id": "biz_xxxxxxxxxxxxxx",
    "title": "Acme Bookkeeping"
  },
  "authorized_user_id": null,
  "code": null,
  "created_at": "2026-01-01T12:00:00.000Z",
  "id": "prfr_xxxxxxxxxxxxxx",
  "max_redemptions": null,
  "member_id": null,
  "partner": {
    "id": "user_xxxxxxxxxxxxxx",
    "name": "Dana Whitfield",
    "profile_picture": {
      "url": "https://ui-avatars.com/api/"
    },
    "username": "danawhitfield"
  },
  "request_type": "manual",
  "rewards": [
    {
      "bot_qualification_type": "sales",
      "id": "<string>",
      "qualification_amount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "recipient": "business",
      "recipient_id": "<string>",
      "reward_amount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      }
    }
  ],
  "status": "accepted",
  "updated_at": "2026-01-01T12:00:00.000Z",
  "user": {
    "id": "user_xxxxxxxxxxxxxx",
    "name": "Dana Whitfield",
    "profile_picture": {
      "url": "https://ui-avatars.com/api/"
    },
    "username": "danawhitfield"
  }
}

{
  "account": {
    "id": "biz_xxxxxxxxxxxxxx",
    "title": "Acme Bookkeeping"
  },
  "authorized_user_id": null,
  "code": null,
  "created_at": "2026-01-01T12:00:00.000Z",
  "id": "prfr_xxxxxxxxxxxxxx",
  "max_redemptions": null,
  "member_id": null,
  "partner": {
    "id": "user_xxxxxxxxxxxxxx",
    "name": "Dana Whitfield",
    "profile_picture": {
      "url": "https://ui-avatars.com/api/"
    },
    "username": "danawhitfield"
  },
  "request_type": "manual",
  "rewards": [
    {
      "bot_qualification_type": "sales",
      "id": "<string>",
      "qualification_amount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "recipient": "business",
      "recipient_id": "<string>",
      "reward_amount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      }
    }
  ],
  "status": "accepted",
  "updated_at": "2026-01-01T12:00:00.000Z",
  "user": {
    "id": "user_xxxxxxxxxxxxxx",
    "name": "Dana Whitfield",
    "profile_picture": {
      "url": "https://ui-avatars.com/api/"
    },
    "username": "danawhitfield"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

POST

partner_referral_requests

Create a partner referral request

curl --request POST \
  --url https://api.whop.com/api/v1/partner_referral_requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "authorized_user_id": "<string>",
  "member_id": "<string>"
}
'

import requests

url = "https://api.whop.com/api/v1/partner_referral_requests"

payload = {
    "account_id": "biz_xxxxxxxxxxxxxx",
    "authorized_user_id": "<string>",
    "member_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    account_id: 'biz_xxxxxxxxxxxxxx',
    authorized_user_id: '<string>',
    member_id: '<string>'
  })
};

fetch('https://api.whop.com/api/v1/partner_referral_requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/partner_referral_requests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account_id' => 'biz_xxxxxxxxxxxxxx',
    'authorized_user_id' => '<string>',
    'member_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/partner_referral_requests"

	payload := strings.NewReader("{\n  \"account_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"authorized_user_id\": \"<string>\",\n  \"member_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.whop.com/api/v1/partner_referral_requests")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"authorized_user_id\": \"<string>\",\n  \"member_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/partner_referral_requests")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"authorized_user_id\": \"<string>\",\n  \"member_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "account": {
    "id": "biz_xxxxxxxxxxxxxx",
    "title": "Acme Bookkeeping"
  },
  "authorized_user_id": null,
  "code": null,
  "created_at": "2026-01-01T12:00:00.000Z",
  "id": "prfr_xxxxxxxxxxxxxx",
  "max_redemptions": null,
  "member_id": null,
  "partner": {
    "id": "user_xxxxxxxxxxxxxx",
    "name": "Dana Whitfield",
    "profile_picture": {
      "url": "https://ui-avatars.com/api/"
    },
    "username": "danawhitfield"
  },
  "request_type": "manual",
  "rewards": [
    {
      "bot_qualification_type": "sales",
      "id": "<string>",
      "qualification_amount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "recipient": "business",
      "recipient_id": "<string>",
      "reward_amount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      }
    }
  ],
  "status": "accepted",
  "updated_at": "2026-01-01T12:00:00.000Z",
  "user": {
    "id": "user_xxxxxxxxxxxxxx",
    "name": "Dana Whitfield",
    "profile_picture": {
      "url": "https://ui-avatars.com/api/"
    },
    "username": "danawhitfield"
  }
}

{
  "account": {
    "id": "biz_xxxxxxxxxxxxxx",
    "title": "Acme Bookkeeping"
  },
  "authorized_user_id": null,
  "code": null,
  "created_at": "2026-01-01T12:00:00.000Z",
  "id": "prfr_xxxxxxxxxxxxxx",
  "max_redemptions": null,
  "member_id": null,
  "partner": {
    "id": "user_xxxxxxxxxxxxxx",
    "name": "Dana Whitfield",
    "profile_picture": {
      "url": "https://ui-avatars.com/api/"
    },
    "username": "danawhitfield"
  },
  "request_type": "manual",
  "rewards": [
    {
      "bot_qualification_type": "sales",
      "id": "<string>",
      "qualification_amount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "recipient": "business",
      "recipient_id": "<string>",
      "reward_amount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      }
    }
  ],
  "status": "accepted",
  "updated_at": "2026-01-01T12:00:00.000Z",
  "user": {
    "id": "user_xxxxxxxxxxxxxx",
    "name": "Dana Whitfield",
    "profile_picture": {
      "url": "https://ui-avatars.com/api/"
    },
    "username": "danawhitfield"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

Authorizations

Authorization

string

header

required

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.

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-10-27-3"

Body

application/json

account_id

string

required

Business to request attribution for, prefixed biz_.

Example:

"biz_xxxxxxxxxxxxxx"

authorized_user_id

string

Your team membership on the business this referral is made for, prefixed ausr_. Omit for a personal referral.

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.

Response

Existing request or referral link returned.

account

object | null

required

Business receiving the request, when one is assigned.

Show child attributes

authorized_user_id

string | null

required

The partner's team membership this referral was created for, prefixed ausr_. null when the referral is personal.

Example:

null

code

string | null

required

Unique referral code, when assigned.

Example:

null

created_at

string

required

When the request was created, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

string

required

Partner referral request ID, prefixed prfr_.

Example:

"prfr_xxxxxxxxxxxxxx"

max_redemptions

integer | null

required

Maximum permitted redemptions, when limited.

Example:

null

member_id

string | null

required

The partner's member record this referral was created for, prefixed mber_, when their role on that business is held on their member record. null otherwise.

Example:

null

partner

object

required

Public profile of the requesting partner.

Show child attributes

request_type

enum<string>

required

How the referral request was initiated.

Available options:

manual,

ownership_transfer,

link

Example:

"manual"

rewards

object[]

required

Show child attributes

status

enum<string> | null

required

The approval state, or null for requests without an approval process.

Available options:

pending,

accepted,

denied,

cancelled,

null

Example:

"accepted"

updated_at

string

required

When the request last changed, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

user

object | null

required

User receiving the attribution request, or null for a business request or referral link.

Show child attributes

Introduction

Reference

Core Resources

Payments

Money

Commerce

Websites

Ads

Analytics

Communication

Partners

Workforce

Media

Developer

Create a Partner Referral Request

Authorizations

Headers

Body

Response