Enrollment commands: update, delete
The Enrollment Verbs update, delete as CLI commands, with inputs, result, refusals and an example.
Reference for Enrollment, one group of Enrollment commands.
Enrollment.update
Changes the given properties of an Enrollment. Verb page.
npx startup-builder do Enrollment.update --json '<input>' [--try | --send | --do]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
npx startup-builder do Enrollment.update --json '{"id":Enrollment.delete
Deletes an Enrollment: a soft delete that keeps its history, undone by Thing.restore. Verb page.
npx startup-builder do Enrollment.delete --json '<input>' [--try | --send | --do]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
npx startup-builder do Enrollment.delete --json '{"id":