Skip to content

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.

Text
npx startup-builder do Candidate.update --json '<input>' [--try | --send | --do]

Emits Candidate.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Candidate.
openingOpeningThe Opening the Person is considered for.
personPersonThe Person, whose record crosses Startups only with Consent.
sourcestringOne of pool, prospecting, listing, or referral.
deltajsonThe per-Verb difference between the Candidate and the incumbent Agent in the tryout.

Returns

OutputTypeRequiredDescription
candidateCandidaterequiredThe Candidate.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
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.

Text
npx startup-builder do Candidate.delete --json '<input>' [--try | --send | --do]

Emits Candidate.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Candidate.

Returns

OutputTypeRequiredDescription
candidateCandidaterequiredThe Candidate.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
npx startup-builder do Candidate.delete --json '{"id":"candidate_CR5hpwMwhW"}'