Enrollment routes: update, delete

Reference for Enrollment, one group of Enrollment routes.

Enrollment.update

Changes the given properties of an Enrollment. Verb page.

Text

PATCH /{namespace}/enrollments/{id}

Path: id. Body, as JSON: the other inputs. 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

Terminal

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

JSON

{
  "api": "https://api.sb/leaseline.app",
  "enrollment": {
    "$id": "https://api.sb/leaseline.app/enrollments/enrollment_t2LKaLorKn",
    "$type": "Enrollment",
    "status": "active",
    "step": "Example step",
    "nextAt": "2026-10-22T12:00:00Z"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Enrollment.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Enrollment.delete

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