Skip to main content
POST
Pause HTTP schedule
The schedule keeps its configuration and stops firing until you call Resume HTTP Schedule.

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"

Response

The paused 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.