Prospect commands: update, delete
The Prospect Verbs update, delete as CLI commands, with inputs, result, refusals and an example.
Reference for Prospect, one group of Prospect commands.
Prospect.update
Changes the given properties of a Prospect. Verb page.
npx startup-builder do Prospect.update --json '<input>' [--try | --send | --do]Emits Prospect.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Prospect. |
foundIn | string | Where the Startup found them. | |
basis | string | The basis on record for contacting them. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
prospect | Prospect | required | The Prospect. |
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 Prospect.update --json '{"id": "prospect_S8bqJCxC9R", "foundIn": "Example found in"}'Prospect.delete
Deletes a Prospect: a soft delete that keeps its history, undone by Thing.restore. Verb page.
npx startup-builder do Prospect.delete --json '<input>' [--try | --send | --do]Emits Prospect.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Prospect. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
prospect | Prospect | required | The Prospect. |
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 Prospect.delete --json '{"id": "prospect_S8bqJCxC9R"}'