Candidate routes: update, delete

Reference for Candidate, one group of Candidate routes.

Candidate.update

Changes the given properties of a Candidate. Verb page.

Text

PATCH /{namespace}/candidates/{id}

Path: id. Body, as JSON: the other inputs. 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

Terminal

curl -X PATCH https://api.sb/leaseline.app/candidates/candidate_CR5hpwMwhW \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"opening":"opening_3rD8qFSOyQ"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "candidate": {
    "$id": "https://api.sb/leaseline.app/candidates/candidate_CR5hpwMwhW",
    "$type": "Candidate",
    "opening": "opening_3rD8qFSOyQ",
    "person": "person_sLqbXbW683",
    "source": "pool",
    "state": "screening"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Candidate.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Candidate.delete

Deletes a Candidate: a soft delete that keeps its history, undone by Thing.restore. Verb page.