Skip to content

by Startups.Studio

Candidate.create

POST /{namespace}/candidates

Creates a Candidate.

Noun: Candidate
Mode: do
Event: Candidate.created

You, to your agent

Add a candidate to PatentPad with an opening and a person.

curl -X POST https://api.sb/patentpad.com/candidates \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"opening":"opening_1","person":"person_1","source":"pool"}'

import { $ } from 'startup-builder'

const candidate = await $.Candidate.create({ opening: 'opening_1', person: 'person_1', source: 'pool' })

npx startup-builder do Candidate.create --json '{"opening":"opening_1","person":"person_1","source":"pool"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Candidate.create({ opening: 'opening_1', person: 'person_1', source: 'pool' })"
  }
}

Create makes a new Candidate from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`opening`	Opening	required	The Opening the Person is considered for.
`person`	Person	required	The Person, whose record crosses Startups only with Consent.
`source`	`string`	required	One of `pool`, `prospecting`, `listing`, or `referral`.
`delta`	`json`		The per-Verb difference between the Candidate and the incumbent Agent in the tryout.

Outputs

Output	Type	Required	Description
`candidate`	Candidate	required	The Candidate.

Effects

Emits Candidate.created.
Two-way: try, send, do.

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.	Candidate.create

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Candidate

Previous Page

Candidate.delete

Next Page