Skip to content

by Startups.Studio

Opening.update

PATCH /{namespace}/openings/{id}

Changes the given properties of an Opening.

Noun: Opening
Mode: do
Event: Opening.updated

You, to your agent

Change the latest opening.

curl -X PATCH https://api.sb/ledgerlark.com/openings/opening_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"role":"role_1"}'

import { $ } from 'startup-builder'

const opening = await $.Opening.update({ id: 'opening_1', role: 'role_1' })

npx startup-builder do Opening.update --json '{"id":"opening_1","role":"role_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Opening.update({ id: 'opening_1', role: 'role_1' })"
  }
}

Update changes the given properties of an Opening. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Opening.
`role`	Role		The Role the Human joins, by taking a share of it.
`kind`	`string`		One of `floor`, `contractor`, `employee`, or `cofounder`.
`reason`	`string`		One of `floor`, `credential`, `edge`, `relationship`, `capital`, `capacity`, or `distribution`.
`hypothesis`	Hypothesis		The result a hire must beat the incumbent Agent on.
`skills`	list of Skill		The Skills required, each citing the Evidence that shows the gap.
`credentials`	list of Credential		The Credentials a Reserved Act in the Role requires.
`commitment`	`string`		Hours per week, from a few hours to full time.
`terms`	`url`		The published terms for this kind of Opening.
`listed`	`boolean`		True once the Opening is public; unlisted Openings reach only the talent pool.

Outputs

Output	Type	Required	Description
`opening`	Opening	required	The Opening.

Effects

Emits Opening.updated.
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.	Opening.update

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

Opening.list

Previous Page

Permission

Next Page