Enrollment commands: cancel, pause, resume
The Enrollment Verbs cancel, pause, resume as CLI commands, with inputs, result, refusals and an example.
Reference for Enrollment, one group of Enrollment commands.
Enrollment.cancel
Cancel ends one Contact’s run through a Sequence for good, with the reason it records as exitReason. Verb page.
npx startup-builder do Enrollment.cancel --json '<input>' [--try | --send | --do]Emits Enrollment.canceled.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
enrollment | Enrollment | required | The Enrollment to end. |
reason | string | required | Why it ends. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
enrollment | Enrollment | required | The Enrollment, now exited. |
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.cancel --json '{"enrollment":Enrollment.pause
Pause stops one Contact’s run through a Sequence at its current step, without ending it. Verb page.
npx startup-builder do Enrollment.pause --json '<input>' [--try | --send | --do]Emits Enrollment.paused.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
enrollment | Enrollment | required | The Enrollment to pause. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
enrollment | Enrollment | required | The Enrollment, now paused. |
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.pause --json '{"enrollment":Enrollment.resume
Resume restarts a paused run at the step it stopped on and sets when that step fires. Verb page.
npx startup-builder do Enrollment.resume --json '<input>' [--try | --send | --do]Emits Enrollment.resumed.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
enrollment | Enrollment | required | The paused Enrollment. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
enrollment | Enrollment | required | The Enrollment, active again. |
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.resume --json '{"enrollment":