Enrollment methods: update, delete

Reference for Enrollment, one group of Enrollment methods.

Enrollment.update

Changes the given properties of an Enrollment. Verb page.

TypeScript

interface EnrollmentVerbs {
  update(input: EnrollmentUpdateInput, options?: SB.CallOptions): SB.Call<Enrollment>
}

Emits Enrollment.updated.

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.

Returns

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

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

Example

TypeScript

import { $ } from 'startup-builder'

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

Deletes an Enrollment: a soft delete that keeps its history, undone by Thing.restore. Verb page.

TypeScript

interface EnrollmentVerbs {
  delete(input: EnrollmentDeleteInput, options?: SB.CallOptions): SB.Call<Enrollment>
}

Emits Enrollment.deleted.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Enrollment.

Returns

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

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

Example

TypeScript

import { $ } from 'startup-builder'

const enrollment = await $.Enrollment.delete({ id: 'enrollment_t2LKaLorKn' })