# Referral

URL: /business/nouns/referral · Id: `noun:referral`

> A Referral is a Contact, Customer, or Partner sending a Lead to a Startup, with any reward it earns.

A Referral is a [Contact](/business/nouns/contact), [Customer](/business/nouns/customer), or [Partner](/business/nouns/partner) sending a [Lead](/business/nouns/lead) to a [Startup](/business/nouns/startup), with any reward it earns.

## Properties
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `reward` | `money` | No | What the referrer earns. |
| `rewardKind` | `string` | No | What the referrer earns: earlier `access`, or `cash`, which pays only after Live. |

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

## Relationships
- <a id="rel-earns"></a>A Referral **earns** one [Commission](/business/nouns/commission): the [Commission](/business/nouns/commission) a [Partner](/business/nouns/partner)’s Referral earns on the revenue it brings, self-serve or through a [Deal](/business/nouns/deal). `earns`, inverse [`referral`](/business/nouns/commission#rel-referral).
- <a id="rel-made-by"></a>A Referral **is made by** one [Party](/business/nouns/party): the [Party](/business/nouns/party) who sends a Referral earns its reward. `madeBy`, inverse [`referrals`](/business/nouns/party#rel-referrals).
- <a id="rel-refers"></a>A Referral **refers** one [Lead](/business/nouns/lead): each Referral sends one [Lead](/business/nouns/lead) to the [Startup](/business/nouns/startup). `refers`, inverse [`referredBy`](/business/nouns/lead#rel-referred-by).
- <a id="rel-sources"></a>A Referral **sources** many [Deals](/business/nouns/deal): the [Deals](/business/nouns/deal) a Referral opened; when one is won, its revenue earns the [Partner](/business/nouns/partner)’s [Commission](/business/nouns/commission). `sources`, inverse [`sourcedBy`](/business/nouns/deal#rel-sourced-by).

## Verbs
| Verb | Description | Subject | Event | Class |
| --- | --- | --- | --- | --- |
| <a id="create"></a>[Referral.create](/business/nouns/referral/create) | Creates a Referral. Inherited from [Noun](/business/nouns/noun). | None. | `Referral.created` | Two-way: `try`, `send`, `do` |
| <a id="get"></a>[Referral.get](/business/nouns/referral/get) | Returns one Referral by id. Inherited from [Noun](/business/nouns/noun). | None. | None. | Read: `try`, `do` |
| <a id="list"></a>[Referral.list](/business/nouns/referral/list) | Returns Referrals, newest first, one page at a time. Inherited from [Noun](/business/nouns/noun). | None. | None. | Read: `try`, `do` |
| <a id="update"></a>[Referral.update](/business/nouns/referral/update) | Changes the given properties of a Referral. Inherited from [Noun](/business/nouns/noun). | None. | `Referral.updated` | Two-way: `try`, `send`, `do` |
| <a id="delete"></a>[Referral.delete](/business/nouns/referral/delete) | Deletes a Referral; its history is kept. Inherited from [Noun](/business/nouns/noun). | None. | `Referral.deleted` | One-way: `send`, `do` |

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

| Operation | `owner` | `admin` | `member` | `viewer` |
| --- | --- | --- | --- | --- |
| `Referral.create` | Yes | Yes | Yes | No |
| `Referral.get` | Yes | Yes | Yes | Yes |
| `Referral.list` | Yes | Yes | Yes | Yes |
| `Referral.update` | Yes | Yes | Yes | No |
| `Referral.delete` | Yes | Yes | Yes | No |

## Call it

**Ask**

```text
Add a referral to ShiftNote.
```

**API**

```bash
curl -X POST https://api.sb/shiftnote.app/referrals \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reward":{"amount":79,"currency":"USD"}}'
```

```json
{
  "api": "https://api.sb/shiftnote.app",
  "referral": {
    "$id": "https://api.sb/shiftnote.app/referrals/referral_1",
    "$type": "Referral",
    "reward": {
      "amount": 79,
      "currency": "USD"
    },
    "rewardKind": "access"
  },
  "action": {
    "$id": "https://api.sb/shiftnote.app/actions/action_1",
    "operation": "Referral.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/shiftnote.app/actions/action_1"
  }
}
```

**SDK**

```ts
import { $ } from 'startup-builder'

const referral = await $.Referral.create({ reward: { amount: 79, currency: 'USD' } })
```

**CLI**

```bash
npx startup-builder do Referral.create --json '{"reward":{"amount":79,"currency":"USD"}}'
```

**MCP**

```json
{
  "name": "do",
  "arguments": {
    "code": "return await $.Referral.create({ reward: { amount: 79, currency: 'USD' } })"
  }
}
```

## Example
A music teacher sends her link to a colleague, who signs up for the lesson-booking [App](/business/nouns/app). The Referral credits the teacher one free month when the colleague pays.