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.
Read the current version before a mutation and send it as expectedVersion. A stale version returns 409; read and reconcile before retrying. The HTTP contract requires this value even where Command Center binds it automatically.
Supply at least one definition field. Material edits create a new immutable revision. Review returned authority and authorityRefreshRequired; do not assume an edited definition has authority for unattended execution.
Path parameters
schedule_idrequiredstring
Exact Scheduled Chat definition ID returned by create or list.
| Name | Type | Description |
|---|---|---|
| schedule_idrequired | string | Exact Scheduled Chat definition ID returned by create or list. |
Body parameters
expectedVersionrequiredinteger
Current schedule version, at least 1. Required for optimistic concurrency.
name· optionalstring
Non-empty display name, at most 160 characters.
prompt· optionalstring
Complete recurring instruction, at most 50,000 characters.
recurrence· optionalobject
rrule and IANA timezone. Recurrence is validated by the host.
resourceRefs· optionalarray
Up to 96 exact {type,id,metadata?} host-owned resources. Metadata supplies labels and does not authorize access.
| Name | Type | Description |
|---|---|---|
| expectedVersionrequired | integer | Current schedule version, at least 1. Required for optimistic concurrency. |
| name | string | Non-empty display name, at most 160 characters. |
| prompt | string | Complete recurring instruction, at most 50,000 characters. |
| recurrence | object | rrule and IANA timezone. Recurrence is validated by the host. |
| resourceRefs | array | Up to 96 exact {type,id,metadata?} host-owned resources. Metadata supplies labels and does not authorize access. |
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. |
