Create a Partner Referral Request
Creates a referral link or sends a verified partner’s attribution request to an existing business or user for approval. Recipients do not need to join the partner program.
Authorizations
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
A unique key that makes this request safe to retry. See Idempotent requests.
255"d9105228-4a08-46b1-8b91-42fed586d383"
Pins the request to a dated API version.
"2026-10-06-2"
Body
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
Business to request attribution for, prefixed biz_.
"biz_xxxxxxxxxxxxxx"
Response
Existing request or referral link returned.
Business receiving the request, when one is assigned.
Unique referral code, when assigned.
null
When the request was created, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"
Partner referral request ID, prefixed prfr_.
"prfr_xxxxxxxxxxxxxx"
Maximum permitted redemptions, when limited.
null
Public profile of the requesting partner.
How the referral request was initiated.
manual, ownership_transfer, link "manual"
The approval state, or null for requests without an approval process.
pending, accepted, denied, cancelled, null "accepted"
When the request last changed, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"
User receiving the attribution request, or null for a business request or referral link.

