Enrollment
Ends one person’s run through a Sequence for good, with the reason.
- Action class
- None
- Approval
- Runs on its own
- Emits
Enrollment.canceled- Price
- Free
Its Inputs, Outputs, Effects and guards quote the hub’s Enrollment.cancel; this page adds what each Venue honors, its limits and a worked call. It is one of the Verbs of Sequences.
Inputs
| Name | Type | Default | Meaning |
|---|---|---|---|
enrollment | Enrollment | Required | The Enrollment to end. |
reason | string | Required | Why it ends. |
Outputs
| Field | Type | What null means |
|---|---|---|
enrollment | Enrollment | Never null: the Enrollment, now exited. |
Effects
- Action class
None: no approval rule names it, so it runs within its seat’s Permissions and Limits
- Modes
try: Runs every check and returns the record as it would be; nothing is stored.send: Returns a pending Action at once;Enrollment.canceledfires when it is done.do: Waits for the Action to finish and returns the record.
- Idempotency
Only with a key: the same
Idempotency-Keyand input return the first Action, and the same key with other input returns409.- Saved or shared
The Enrollment is saved as the call leaves it, with the Action that changed it.
- Emits
Enrollment.canceledwith{ enrollment }- Performed by
- Price
Free on your own account: the platform charges nothing for the call.
On each Venue
It acts on your own records and reaches no Venue, so every account answers the same way.
What try does
Runs every check the call meets and returns the record as it would be; nothing is stored, sent or posted.
Refuses when
The hub sets no guard of its own on this call: it refuses only on the shared checks every write meets (a missing record, a Permission the seat lacks).
When it waits
Returns in one response; nothing waits.
Example
In send mode the call returns its pending Action at once, and Enrollment.canceled delivers the result.
Rosa booked a call: end her first-touch run. {
"mode": "send",
"action": {
"$id": "https://api.sb/leaseline.app/actions/action_Sd3kQ9vT2w" ,
"operation": "Enrollment.cancel",
"status": "pending",
"reason": "running"
}
}To retry, send the same Idempotency-Key: the retry returns the first answer for $0. A new key reads again.
Used by
None.