Skip to main content
POST
CSharp (SDK)

Authorizations

Authorization
string
header
required

Send Authorization: Bearer , using an MKA1 API key for automation or an OAuth API access token for a signed-in application. Use a dynamic security callback to refresh OAuth access tokens. Browser session-only operations still require their declared cookie.

Headers

X-On-Behalf-Of
string

Optional external end-user identifier forwarded by the API gateway.

Path Parameters

schedule_id
string
required

Response

200 - application/json

OK

id
string
required
object
any
required
name
string
required
description
string | null
required
suite_id
string
required
suite_version
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
cron
string | null
required
interval_seconds
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
timezone
string
required
overlap_policy
enum<string>
required
Available options:
skip,
buffer_one,
allow_all
enabled
boolean
required
webhook_url
string | null
required
webhook_configured
boolean
required

True when a signing secret is stored. The secret itself is never returned.

run
object
required

Persisted schedule run configuration. Unknown stored fields remain readable without becoming supported execution controls.

metadata
object
required
last_run_id
string | null
required
last_run_at
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
last_run_status
string | null
required
next_run_at
integer | null
required

Next scheduled fire time from Temporal, when resolvable.

Required range: -9007199254740991 <= x <= 9007199254740991
stalled
boolean | null
required

True when the schedule is enabled but Temporal will not fire it: its Temporal schedule is missing, paused, or has no next fire time. Null when Temporal could not be reached. It reads only Temporal's schedule state, so a schedule whose fires fail to start runs stays false; see last_run_status.

created_at
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
updated_at
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991