Referral commands: update, delete
The Referral Verbs update, delete as CLI commands, with inputs, result, refusals and an example.
Reference for Referral, one group of Referral commands.
Referral.update
Changes the given properties of a Referral. Verb page.
npx startup-builder do Referral.update --json '<input>' [--try | --send | --do]Emits Referral.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Referral. |
reward | money | What the referrer earns. | |
rewardKind | string | What the referrer earns: earlier access, or cash, which pays only after Live. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
referral | Referral | required | The Referral. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
npx startup-builder do Referral.update --json '{"id":Referral.delete
Deletes a Referral: a soft delete that keeps its history, undone by Thing.restore. Verb page.
npx startup-builder do Referral.delete --json '<input>' [--try | --send | --do]Emits Referral.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Referral. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
referral | Referral | required | The Referral. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
npx startup-builder do Referral.delete --json '{"id":