Skip to content

by Startups.Studio

Core grammar Noun

Noun.retire

POST /{namespace}/nouns/{noun}/retire

Retire removes a published Noun from new Versions; its records, its history and every pinned Version keep serving.

Noun: Noun
Mode: do
Event: Noun.retired

You, to your agent

Retire the latest noun.

curl -X POST https://api.sb/shiftnote.app/nouns/noun_1/retire \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const { version, noun } = await $.Noun.retire({ noun: 'noun_1' })

npx startup-builder do Noun.retire --json '{"noun":"noun_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Noun.retire({ noun: 'noun_1' })"
  }
}

Inputs

Input	Type	Required	Description
`noun`	Noun	required	The Noun to retire.

Outputs

Output	Type	Required	Description
`version`	Version	required	The new Version, without the Noun.
`noun`	Noun	required	The Noun, now retired from new Versions.

Effects

Emits Noun.retired.
Performed by the Product Lead.
One-way (customer): it waits out its delay window, and runs in the send and do modes.
Opens a new Version without the Noun through a Change.
Keeps every Version a Customer pins serving it.

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.	Noun.retire

When it waits

Gate	Default
Decision class	High: one-way, broad (customer)
Delay window	1 business day, in which a watcher can pause, redirect or cancel it; then it runs.
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`.

Noun.list

Previous Page

Noun.trace

Next Page