Candidate commands: update, delete
The Candidate Verbs update, delete as CLI commands, with inputs, result, refusals and an example.
Reference for Candidate, one group of Candidate commands.
Candidate.update
Changes the given properties of a Candidate. Verb page.
npx startup-builder do Candidate.update --json '<input>' [--try | --send | --do]Emits Candidate.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Candidate. |
opening | Opening | The Opening the Person is considered for. | |
person | Person | The Person, whose record crosses Startups only with Consent. | |
source | string | One of pool, prospecting, listing, or referral. | |
delta | json | The per-Verb difference between the Candidate and the incumbent Agent in the tryout. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
candidate | Candidate | required | The Candidate. |
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 Candidate.update --json '{"id": "candidate_CR5hpwMwhW", "opening": "opening_3rD8qFSOyQ"}'Candidate.delete
Deletes a Candidate: a soft delete that keeps its history, undone by Thing.restore. Verb page.
npx startup-builder do Candidate.delete --json '<input>' [--try | --send | --do]Emits Candidate.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Candidate. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
candidate | Candidate | required | The Candidate. |
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 Candidate.delete --json '{"id": "candidate_CR5hpwMwhW"}'