Skip to main content
POST
Bulk pause schedules
Send a JSON array of schedule IDs. The response reports how many schedules were paused, how many were already paused, how many IDs were not found, and how many were not valid IDs.

Authorizations

x-api-key
string
header
required

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

Body

application/json
Maximum array length: 100
Example:

Response

Summary of the bulk pause.

message
string
required

Human-readable summary of the operation.

total_requested
integer
required

Number of schedule IDs submitted.

paused_count
integer
default:0

Number of schedules paused by this request.

already_paused_count
integer
default:0

Number of schedules that were already paused and were skipped.

not_found_count
integer
default:0

Number of IDs that did not match a schedule.

invalid_count
integer
default:0

Number of IDs that were not in a valid ID format.

paused_schedules
object[]

Full details of the schedules paused by this request.