# Referral routes: update, delete

URL: /code/api/referral/records-update · Id: `page:code/api/referral/records-update`

> The Referral Verbs update, delete as api.sb routes, with inputs, result, refusals and an example.

Reference for [Referral](/business/nouns/referral), one group of [Referral routes](/code/api/referral).

### Referral.update
Changes the given properties of a Referral. [Verb page](/business/nouns/referral/update?interface=api).

```text
PATCH /{namespace}/referrals/{id}
```

Path: `id`. Body, as JSON: the other inputs. Emits `Referral.updated`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Referral. |
| `reward` | `money` | No | What the referrer earns. |
| `rewardKind` | `string` | No | What the referrer earns: earlier `access`, or `cash`, which pays only after Live. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `referral` | [Referral](/business/nouns/referral) | Yes | The Referral. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

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

```json
{
  "api": "https://api.sb/leaseline.app",
  "referral": {
    "$id": "https://api.sb/leaseline.app/referrals/referral_I89J7wngKt",
    "$type": "Referral",
    "reward": {
      "amount": 29,
      "currency": "USD"
    },
    "rewardKind": "access"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Referral.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```

### Referral.delete
Deletes a Referral: a soft delete that keeps its history, undone by `Thing.restore`. [Verb page](/business/nouns/referral/delete?interface=api).

```text
DELETE /{namespace}/referrals/{id}
```

Path: `id`. Emits `Referral.deleted`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Referral. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `referral` | [Referral](/business/nouns/referral) | Yes | The Referral. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
curl -X DELETE https://api.sb/leaseline.app/referrals/referral_I89J7wngKt \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "referral": {
    "$id": "https://api.sb/leaseline.app/referrals/referral_I89J7wngKt",
    "$type": "Referral",
    "reward": {
      "amount": 29,
      "currency": "USD"
    },
    "rewardKind": "access"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Referral.delete",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```