Skip to content

by Startups.Studio

OverviewStartup

Startup.update

PATCH /{namespace}/startups/{id}

Changes the given properties of a Startup.

Noun: Startup
Mode: do
Event: Startup.updated

You, to your agent

Change PetPantry.

curl -X PATCH https://api.sb/petpantry.shop/startups/startup_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"PetPantry"}'

import { $ } from 'startup-builder'

const startup = await $.Startup.update({ id: 'startup_1', name: 'PetPantry' })

npx startup-builder do Startup.update --json '{"id":"startup_1","name":"PetPantry"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Startup.update({ id: 'startup_1', name: 'PetPantry' })"
  }
}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Startup.
`name`	`string`		The name the Startup trades under.
`domain`	`url`		The canonical hostname of the Startup.
`launchedAt`	`datetime`		When the Startup went live.
`template`	`string`		The slug of the template it extends; the root one when none is named.
`idea`	`text`		The Idea it starts from, in a sentence, recorded as its Idea.
`spendState`	`string`		How freely money Limits allow spend: `free`, `tight` (discretionary Limits halved) or `hold` (one-way spend stops).

Outputs

Output	Type	Required	Description
`startup`	Startup	required	The Startup.

Effects

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