Skip to content

by Startups.Studio

OverviewStartup

Startup.pause

POST /{namespace}/startups/{startup}/pause

Pause moves a Startup to Dormant: its scheduled Workflows stop, and its Sites and records stay in place.

Noun: Startup
Mode: do
Event: Startup.paused

You, to your agent

Pause ShiftNote.

curl -X POST https://api.sb/shiftnote.app/startups/startup_1/pause \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const startup = await $.Startup.pause({ startup: 'startup_1' })

npx startup-builder do Startup.pause --json '{"startup":"startup_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Startup.pause({ startup: 'startup_1' })"
  }
}

Inputs

Input	Type	Required	Description
`startup`	Startup	required	The Startup to pause.
`reason`	`text`		Why the Startup pauses.

Outputs

Output	Type	Required	Description
`startup`	Startup	required	The Startup, now Dormant.

Effects

Emits Startup.paused.
Performed by the Founder.
Stops every scheduled Workflow.
Records the state the Startup held, for resume.
Deletes nothing.

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.pause
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	Startup.pause

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