> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lyzr.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Bulk Pause Schedules

> Pause up to 100 agent schedules at once.

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.


## OpenAPI

````yaml openapi/scheduler.yaml POST /schedules/pause-bulk/
openapi: 3.0.3
info:
  title: Lyzr Scheduler and Webhooks API
  version: 1.1.0
  description: >-
    Scheduler service for running Lyzr agents on cron schedules, triggering
    agents from external systems through signed webhooks, and calling arbitrary
    HTTP endpoints on a cron schedule.
servers:
  - url: https://scheduler.studio.lyzr.ai
security:
  - ApiKeyAuth: []
tags:
  - name: Schedules
    description: Run an agent on a cron schedule.
  - name: Agent Webhooks
    description: Create and manage webhook URLs that trigger an agent.
  - name: Webhook Trigger
    description: Public endpoint external services call to trigger an agent.
  - name: HTTP Schedules
    description: Call any HTTP endpoint on a cron schedule.
paths:
  /schedules/pause-bulk/:
    post:
      tags:
        - Schedules
      summary: Bulk pause schedules
      description: Pause up to 100 agent schedules at once.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              maxItems: 100
              description: Schedule IDs to pause.
              items:
                type: string
              example:
                - 66f1c2a9e4b0a1b2c3d4e5f6
                - 66f1c2a9e4b0a1b2c3d4e5f9
      responses:
        '200':
          description: Summary of the bulk pause.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkPauseResponse'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  schemas:
    BulkPauseResponse:
      type: object
      required:
        - message
        - total_requested
      properties:
        message:
          type: string
          description: Human-readable summary of the operation.
        total_requested:
          type: integer
          description: Number of schedule IDs submitted.
        paused_count:
          type: integer
          default: 0
          description: Number of schedules paused by this request.
        already_paused_count:
          type: integer
          default: 0
          description: Number of schedules that were already paused and were skipped.
        not_found_count:
          type: integer
          default: 0
          description: Number of IDs that did not match a schedule.
        invalid_count:
          type: integer
          default: 0
          description: Number of IDs that were not in a valid ID format.
        paused_schedules:
          type: array
          description: Full details of the schedules paused by this request.
          items:
            $ref: '#/components/schemas/ScheduleResponse'
    ScheduleResponse:
      type: object
      required:
        - id
        - user_id
        - agent_id
        - message
        - cron_expression
        - timezone
        - created_at
      properties:
        id:
          type: string
          description: Unique schedule ID.
          example: 66f1c2a9e4b0a1b2c3d4e5f6
        user_id:
          type: string
          example: user@example.com
        agent_id:
          type: string
          example: 66e9b0f2a1c3d4e5f6a7b8c9
        message:
          type: string
          example: Summarize yesterday's support tickets and flag anything urgent.
        cron_expression:
          type: string
          example: 0 9 * * 1-5
        timezone:
          type: string
          example: Asia/Kolkata
        max_retries:
          type: integer
          default: 3
        retry_delay:
          type: integer
          default: 60
        is_active:
          type: boolean
          default: true
          description: '`false` when the schedule is paused.'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
          nullable: true
        next_run_time:
          type: string
          format: date-time
          nullable: true
          description: When the schedule will next fire. `null` while paused.
        last_run_at:
          type: string
          format: date-time
          nullable: true
        last_run_success:
          type: boolean
          nullable: true
          description: >-
            Outcome of the most recent run. `null` if the schedule has never
            run.
    Error:
      type: object
      properties:
        detail:
          type: string
          example: Schedule not found
    HTTPValidationError:
      type: object
      properties:
        detail:
          type: array
          items:
            type: object
            properties:
              loc:
                type: array
                description: Path to the invalid field.
                items:
                  oneOf:
                    - type: string
                    - type: integer
              msg:
                type: string
                description: Human-readable error message.
              type:
                type: string
                description: Error type identifier.
  responses:
    Forbidden:
      description: The `x-api-key` header is missing or the key is invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            missing:
              summary: Missing API key
              value:
                detail: API key missing
            invalid:
              summary: Invalid API key
              value:
                detail: Invalid Permission
    ValidationError:
      description: The request failed validation. The body lists each invalid field.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/HTTPValidationError'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Lyzr API key. Required on every endpoint except Trigger Webhook.

````