Referral

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

{
  "$id": "https://api.sb/patentpad.com/referrals/referral_1",
  "$type": "Referral",
  "reward": {
    "amount": 499,
    "currency": "USD"
  },
  "rewardKind": "access"
}

RelationshipsCopy Anchor Link

• A Referral earns one Commission: the Commission a Partner’s Referral earns on the revenue it brings, self-serve or through a Deal. earns, inverse referral.
• A Referral is made by one Party: the Party who sends a Referral earns its reward. madeBy, inverse referrals.
• A Referral refers one Lead: each Referral sends one Lead to the Startup. refers, inverse referredBy.
• A Referral sources many Deals: the Deals a Referral opened; when one is won, its revenue earns the Partner’s Commission. sources, inverse sourcedBy.

VerbsCopy Anchor Link

1. createCreates a Referral.
   POST /{namespace}/referralsdoReferral.created
2. getReturns one Referral by id.
   GET /{namespace}/referrals/{id}readNo Event
3. listReturns Referrals, newest first, one page at a time.
   GET /{namespace}/referralsreadNo Event
4. updateChanges the given properties of a Referral.
   PATCH /{namespace}/referrals/{id}doReferral.updated
5. deleteDeletes a Referral; its history is kept.
   DELETE /{namespace}/referrals/{id}doReferral.deleted

PermissionsCopy Anchor Link

Which Access level may call each Verb. One-way Verbs wait their delay window.

Call itCopy Anchor Link

Add a referral to ShiftNote.

ExampleCopy Anchor Link

A music teacher sends her link to a colleague, who signs up for the lesson-booking App. The Referral credits the teacher one free month when the colleague pays.