This page documents the canonical HTTP contract for this endpoint.
Authenticate with the signed-in user session using a bearer token or the accessToken cookie. Developer API keys are blocked. Definitions, runs, and attention belong to the current user; current workspace membership is rechecked before accessing saved resources. Lists may include your own work across accessible workspaces.
A cancellation request can return cancel_requested. Poll the occurrence to observe its terminal outcome; it does not undo already-completed effects.
Path parameters
schedule_idrequiredstring
Exact Scheduled Chat definition ID returned by create or list.
occurrence_idrequiredstring
Exact durable occurrence ID returned by run-now or list runs.
| Name | Type | Description |
|---|---|---|
| schedule_idrequired | string | Exact Scheduled Chat definition ID returned by create or list. |
| occurrence_idrequired | string | Exact durable occurrence ID returned by run-now or list runs. |
Body parameters
reason· optionalstring
1–1,000 character reason; defaults to Cancelled by user. The whole request body may be omitted.
| Name | Type | Description |
|---|---|---|
| reason | string | 1–1,000 character reason; defaults to Cancelled by user. The whole request body may be omitted. |
Errors
| Status | Meaning |
|---|---|
| 401 | A valid signed-in user session is required. |
| 403 | Developer API keys are blocked or workspace access is unavailable. |
| 404 | The owner-scoped schedule, run, attention item, or referenced resource is unavailable. |
| 409 | The version, status transition, authority, or active occurrence conflicts with this request. |
| 422 | Invalid request fields, recurrence, or resource references. |
