Skip to content

by Startups.Studio

Growth Enrollment

Enrollment.resume

POST /{namespace}/enrollments/{enrollment}/resume

Resume restarts a paused run at the step it stopped on and sets when that step fires.

Noun: Enrollment
Mode: do
Event: Enrollment.resumed

You, to your agent

Resume the latest enrollment.

curl -X POST https://api.sb/shiftnote.app/enrollments/enrollment_1/resume \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const enrollment = await $.Enrollment.resume({ enrollment: 'enrollment_1' })

npx startup-builder do Enrollment.resume --json '{"enrollment":"enrollment_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Enrollment.resume({ enrollment: 'enrollment_1' })"
  }
}

Inputs

Input	Type	Required	Description
`enrollment`	Enrollment	required	The paused Enrollment.

Outputs

Output	Type	Required	Description
`enrollment`	Enrollment	required	The Enrollment, `active` again.

Effects

Emits Enrollment.resumed.
Performed by the Prospector.
Two-way: it runs at once, in the try, send and do modes.
Sets nextAt from the step’s wait, counted from now.

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.	Enrollment.resume

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

Enrollment.pause

Previous Page

Enrollment.update

Next Page