BizKitHub
DocsAPI ReferenceCron/bff/cron/job-update
postCronAdmin BFF

/bff/cron/job-update

Rename a cron job, toggle its alerts or set its expected schedule

CronpostBffCronJob-update

Parameters

JSON body

Request body

application/json
idstringRequired
Length: 16–16
namestring | nullOptional
One of 2:
Variant 1
string

New name (locks it against starts). null hands the name back to the client.

Length: 0–128
Variant 2
null
isAlertEnabledbooleanOptional
schedulestring | nullOptional
One of 2:
Variant 1
string

Cron expression; null removes the schedule.

Length: 0–120
Variant 2
null
scheduleTimezonestring | nullOptional
One of 2:
Variant 1
string

IANA time zone; null = UTC.

Length: 0–64
Variant 2
null
graceSecondsstring | integer | nullOptional
One of 2:
Variant 1
string | integer
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
Range: 0–604800
Variant 2
null
isScheduleLockedbooleanOptional

Editing the schedule locks it automatically; false lets starts update it again.

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json
{
  "success": true
}

Request example

POST /bff/cron/job-update

post
curl -X POST "https://api.bizkithub.com/bff/cron/job-update" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "id": "example_id",
  "isAlertEnabled": false,
  "isScheduleLocked": false
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key