# Referral commands: update, delete

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

> The Referral Verbs update, delete as CLI commands, with inputs, result, refusals and an example.

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

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

```text
npx startup-builder do Referral.update --json '<input>' [--try | --send | --do]
```

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
npx startup-builder do Referral.update --json '{"id":"referral_I89J7wngKt","reward":{"amount":29,"currency":"USD"}}'
```

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

```text
npx startup-builder do Referral.delete --json '<input>' [--try | --send | --do]
```

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
npx startup-builder do Referral.delete --json '{"id":"referral_I89J7wngKt"}'
```