Skip to content

by Startups.Studio

OverviewStartup Template

StartupTemplate.upgrade

POST /{namespace}/startup-templates/{startupTemplate}/upgrade

Upgrade moves a Startup to a newer Version of a Startup Template it extends, through a Change it can review.

Noun: Startup Template
Mode: do
Event: StartupTemplate.upgraded

You, to your agent

Upgrade the latest startup template with a startup.

curl -X POST https://api.sb/shiftnote.app/startup-templates/startup_template_1/upgrade \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"startup":"startup_1"}'

import { $ } from 'startup-builder'

const { change, startupTemplate } = await $.StartupTemplate.upgrade({ startupTemplate: 'startup_template_1', startup: 'startup_1' })

npx startup-builder do StartupTemplate.upgrade --json '{"startupTemplate":"startup_template_1","startup":"startup_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.StartupTemplate.upgrade({ startupTemplate: 'startup_template_1', startup: 'startup_1' })"
  }
}

Inputs

Input	Type	Required	Description
`startupTemplate`	Startup Template	required	The Startup Template to upgrade.
`startup`	Startup	required	The Startup that extends it.
`version`	Version		The target Version; the latest when absent.

Outputs

Output	Type	Required	Description
`change`	Change	required	The Change that moves the pin, with its three-way diff.
`startupTemplate`	Startup Template	required	The Startup Template upgraded to.

Effects

Emits StartupTemplate.upgraded.
Performed by the Engineering Lead.
Two-way: it runs at once, in the try, send and do modes.
Opens a Change; nothing moves until it merges.
Names each dependency the Change moves, from which Version to which.

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.	StartupTemplate.upgrade

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