ScheduleState

Type object or object or object or object

One of 4 shapes:

state: "active"
Field Type Description
ownerrequired string
staterequired "active"
state: "paused"
Field Type Description
ownerrequired string
reasonrequired SchedulePauseReason
A content-free reason a schedule is ineligible to fire.
staterequired "paused"
state: "handoff_pending"
Field Type Description
ownerrequired string
requestsrequired array of HandoffId
staterequired "handoff_pending"
state: "retired"
Field Type Description
staterequired "retired"

Field	Type	Description
ownerrequired	string
staterequired	"active"

Field	Type	Description
ownerrequired	string
reasonrequired	SchedulePauseReason	A content-free reason a schedule is ineligible to fire.
staterequired	"paused"

Field	Type	Description
staterequired	"retired"

Example

{
  "owner": "string",
  "state": "active"
}

The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.

Generated from contract version 1. Last updated November 12, 2026.