Skip to main content
PATCH
Update HTTP schedule
Send only the fields you want to change. Any change re-registers the schedule, so next_run_time is recalculated. Set is_active to false to pause the schedule or true to resume it.

Authorizations

x-api-key
string
header
required

Lyzr API key. Required on every endpoint except Trigger Webhook.

Path Parameters

schedule_id
string
required

ID of the schedule.

Example:

"66f1c2a9e4b0a1b2c3d4e5f6"

Body

application/json

All fields are optional. Only the fields you send are changed.

url
string

Absolute URL to call.

method
enum<string>
Available options:
GET,
POST,
PUT,
PATCH,
DELETE
headers
object

Replaces the stored headers.

body
any

Request body. Objects and arrays are sent as JSON; any other value is sent as a raw string.

timeout_seconds
number
Required range: 1 <= x <= 600
cron_expression
string

Five-field cron expression: minute hour day month day_of_week. Day-of-week follows standard cron numbering (0 or 7 = Sunday, 1 = Monday, ..., 6 = Saturday).

Example:

"0 9 * * 1-5"

timezone
string
max_retries
integer
Required range: 0 <= x <= 5
retry_delay
integer
Required range: 10 <= x <= 3600
label
string
is_active
boolean

Set to false to pause or true to resume.

Response

The updated HTTP schedule.

id
string
required
Example:

"66f1c4d2e4b0a1b2c3d4e5f8"

url
string
required
Example:

"https://api.example.com/reports/refresh"

method
string
required
Example:

"POST"

timeout_seconds
number
required
Example:

120

cron_expression
string
required
Example:

"0 2 * * *"

timezone
string
required
Example:

"UTC"

created_at
string<date-time>
required
headers
object
body
any

Stored request body.

max_retries
integer
default:3
retry_delay
integer
default:60
label
string | null
Example:

"Nightly report refresh"

is_active
boolean
default:true

false when the schedule is paused.

updated_at
string<date-time> | null
next_run_time
string<date-time> | null

When the schedule will next fire. null while paused.

last_run_at
string<date-time> | null
last_run_success
boolean | null
last_run_status
integer | null

HTTP status code returned by the target on the most recent run.

last_attempt_count
integer | null

Number of attempts the most recent run took.