Skip to content

by Startups.Studio

Growth Enrollment

Enrollment.update

PATCH /{namespace}/enrollments/{id}

Changes the given properties of an Enrollment.

Noun: Enrollment
Mode: do
Event: Enrollment.updated

You, to your agent

Change the latest enrollment.

curl -X PATCH https://api.sb/patentpad.com/enrollments/enrollment_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"nextAt":"2026-10-22T12:00:00Z"}'

import { $ } from 'startup-builder'

const enrollment = await $.Enrollment.update({ id: 'enrollment_1', nextAt: '2026-10-22T12:00:00Z' })

npx startup-builder do Enrollment.update --json '{"id":"enrollment_1","nextAt":"2026-10-22T12:00:00Z"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Enrollment.update({ id: 'enrollment_1', nextAt: '2026-10-22T12:00:00Z' })"
  }
}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Enrollment.
`step`	`string`		The Sequence step the person is on.
`nextAt`	`datetime`		When the next step fires; empty while paused or exited.
`branches`	`string[]`		The branches taken so far, in order.
`exitReason`	`string`		Why the run ended.

Outputs

Output	Type	Required	Description
`enrollment`	Enrollment	required	The Enrollment.

Effects

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

Enrollment.resume

Previous Page

Experiment

Next Page