Lead commands: update, delete
The Lead Verbs update, delete as CLI commands, with inputs, result, refusals and an example.
Reference for Lead, one group of Lead commands.
Lead.update
Changes the given properties of a Lead. Verb page.
npx startup-builder do Lead.update --json '<input>' [--try | --send | --do]Emits Lead.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Lead. |
email | email | The primary email address. | |
phone | string | The primary phone number. | |
name | string | The name the Contact goes by. | |
interest | text | What the Lead asked for. | |
owner | Worker | The Worker who answers it. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
lead | Lead | required | The Lead. |
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 Lead.update --json '{"id":Lead.delete
Deletes a Lead: a soft delete that keeps its history, undone by Thing.restore. Verb page.
npx startup-builder do Lead.delete --json '<input>' [--try | --send | --do]Emits Lead.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Lead. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
lead | Lead | required | The Lead. |
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 Lead.delete --json '{"id":