Skip to main content
PATCH
CSharp (SDK)

Authorizations

Authorization
string
header
required

Gateway auth: send Authorization: Bearer <mka1-api-key>. For multi-user server-side integrations, you can also send X-On-Behalf-Of: <external-user-id>.

Headers

X-On-Behalf-Of
string

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

Path Parameters

schedule_id
string
required

Body

application/json
name
string
Required string length: 1 - 255
description
string | null
Maximum string length: 10000
suite_version
integer | null
Required range: 1 <= x <= 2147483647
cron
string | null
Required string length: 1 - 255
interval_seconds
integer | null
Required range: 60 <= x <= 31536000
timezone
string
Required string length: 1 - 64
overlap_policy
enum<string>
Available options:
skip,
buffer_one,
allow_all
enabled
boolean
webhook_url
string<uri> | null

HTTPS endpoint notified of run status transitions.

Maximum string length: 2048
webhook_secret
string | null

Secret used to HMAC-SHA256 sign webhook payloads.

Required string length: 16 - 256
run
object
metadata
object

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
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
created_at
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
updated_at
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991