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

# Update schedule

> Replace schedule settings. For playbook schedules, target.project_id and target.playbook_id must match the current scheduled playbook.



## OpenAPI

````yaml https://api.summation.com/openapi.json put /v1/schedules/{schedule_id}
openapi: 3.1.0
info:
  title: summation-api public API
  version: 0.1.0
servers: []
security: []
tags:
  - name: Auth
    description: Machine authentication for API clients.
  - name: Tenant
    description: Organization and tenant context resolved by summation-api.
  - name: Projects
    description: Project resources.
  - name: Conversations
    description: Conversation and message resources.
  - name: Reports
    description: Report resources and report operations.
  - name: Runs
    description: Project run history and execution status.
  - name: Playbooks
    description: Playbook resources.
  - name: Files
    description: Project file resources.
  - name: Catalog Entries
    description: Project-scoped data asset attachments.
  - name: Data Connectors
    description: Reusable external data source connections.
  - name: App Connectors
    description: External app connectors whose tools the agent can use during chat.
  - name: Tables
    description: Canonical table metadata and catalog.
  - name: Views
    description: Canonical Summation view metadata and catalog.
  - name: Query Executions
    description: Read-only SQL query execution.
  - name: Grid
    description: Materialized grid status, sync, and lineage.
  - name: Schedules
    description: Schedule and schedule run inspection.
paths:
  /v1/schedules/{schedule_id}:
    put:
      tags:
        - Schedules
      summary: Update schedule
      description: >-
        Replace schedule settings. For playbook schedules, target.project_id and
        target.playbook_id must match the current scheduled playbook.
      operationId: update_schedule
      parameters:
        - name: schedule_id
          in: path
          required: true
          schema:
            type: string
            title: Schedule Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlaybookScheduleCreateRequest'
              oneOf:
                - $ref: '#/components/schemas/PlaybookScheduleCreateRequest'
              discriminator:
                propertyName: kind
                mapping:
                  playbook: '#/components/schemas/PlaybookScheduleCreateRequest'
            examples:
              playbook:
                summary: Daily playbook schedule
                value:
                  kind: playbook
                  target:
                    project_id: proj_123
                    playbook_id: file_123
                  description: Daily executive report
                  schedule:
                    type: daily
                    zone_id: America/Los_Angeles
                    time_of_day: '09:00'
                  config:
                    params:
                      region: west
                    output_folder: /Reports
                    email_recipients:
                      - email: ops@example.com
                        type: to
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '400':
          description: Invalid request or unsupported option.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemError'
        '401':
          description: Missing, invalid, or expired credentials.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemError'
        '403':
          description: Authenticated but missing the required scope.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemError'
        '404':
          description: Resource not found or not accessible.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemError'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemError'
        '500':
          description: Internal server error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemError'
      security:
        - SummationMachineAuth:
            - agent:write
components:
  schemas:
    PlaybookScheduleCreateRequest:
      properties:
        kind:
          type: string
          const: playbook
          title: Kind
          description: Schedule target kind.
          default: playbook
        target:
          $ref: '#/components/schemas/PlaybookScheduleTargetRequest'
        description:
          type: string
          title: Description
          description: Human-readable schedule description.
          default: ''
        schedule:
          $ref: '#/components/schemas/ScheduleExpression'
          description: Schedule cadence and timezone.
        config:
          $ref: '#/components/schemas/PlaybookScheduleConfigRequest'
      type: object
      required:
        - target
        - schedule
      title: PlaybookScheduleCreateRequest
    ProblemError:
      description: >-
        Public error envelope (RFC 7807 ``application/problem+json``).


        Mirrors the body produced by :func:`api_error`. Declaring it in the
        contract

        lets generated clients type error handling instead of guessing.
      properties:
        type:
          description: URI reference identifying the problem type.
          title: Type
          type: string
        title:
          description: Short, human-readable summary of the problem type.
          title: Title
          type: string
        status:
          description: HTTP status code.
          title: Status
          type: integer
        detail:
          description: Human-readable explanation specific to this occurrence.
          title: Detail
          type: string
        code:
          description: Stable, machine-readable error code.
          title: Code
          type: string
        request_id:
          description: Correlation id, echoed in the x-request-id header.
          title: Request Id
          type: string
      required:
        - type
        - title
        - status
        - detail
        - code
        - request_id
      title: ProblemError
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PlaybookScheduleTargetRequest:
      properties:
        project_id:
          type: string
          minLength: 1
          title: Project Id
          description: Project that owns the playbook.
        playbook_id:
          type: string
          minLength: 1
          title: Playbook Id
          description: Project playbook file id to schedule.
      type: object
      required:
        - project_id
        - playbook_id
      title: PlaybookScheduleTargetRequest
    ScheduleExpression:
      properties:
        type:
          type: string
          enum:
            - cron
            - interval
            - one_time
            - daily
            - weekly
            - biweekly
            - monthly
            - month_end
            - yearly
          title: Type
        zone_id:
          type: string
          title: Zone Id
          description: IANA timezone ID, for example America/Los_Angeles
          default: UTC
        cron_expression:
          anyOf:
            - type: string
            - type: 'null'
          title: Cron Expression
        every_minutes:
          anyOf:
            - type: integer
              maximum: 1440
              minimum: 1
            - type: 'null'
          title: Every Minutes
        time_of_day:
          anyOf:
            - type: string
            - type: 'null'
          title: Time Of Day
          description: Local HH:mm or HH:mm:ss time
          default: '09:00'
        run_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Run Date
        days_of_week:
          items:
            type: string
            enum:
              - MONDAY
              - TUESDAY
              - WEDNESDAY
              - THURSDAY
              - FRIDAY
              - SATURDAY
              - SUNDAY
          type: array
          title: Days Of Week
        month:
          anyOf:
            - type: integer
              maximum: 12
              minimum: 1
            - type: 'null'
          title: Month
        day_of_month:
          anyOf:
            - type: integer
              maximum: 31
              minimum: 1
            - type: 'null'
          title: Day Of Month
        interval:
          type: integer
          maximum: 12
          minimum: 1
          title: Interval
          default: 1
        anchor_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Anchor Date
      type: object
      required:
        - type
      title: ScheduleExpression
    PlaybookScheduleConfigRequest:
      properties:
        params:
          additionalProperties:
            type: string
          type: object
          title: Params
          description: String parameters passed to the playbook run.
        output_folder:
          type: string
          title: Output Folder
          description: Project folder for generated outputs.
          default: /Reports
        paused:
          type: boolean
          title: Paused
          description: Create or update the schedule in a paused state.
          default: false
        max_concurrent_runs:
          type: integer
          maximum: 5
          minimum: 1
          title: Max Concurrent Runs
          description: Maximum concurrent runs for this schedule.
          default: 1
        output_config:
          additionalProperties: true
          type: object
          title: Output Config
          description: >-
            Non-sensitive output configuration such as subject templates or
            attachment names.
        email_recipients:
          items:
            $ref: '#/components/schemas/PlaybookScheduleEmailRecipientRequest'
          type: array
          maxItems: 50
          title: Email Recipients
          description: Email recipients for scheduled playbook delivery.
      type: object
      title: PlaybookScheduleConfigRequest
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    PlaybookScheduleEmailRecipientRequest:
      properties:
        email:
          type: string
          maxLength: 320
          minLength: 3
          title: Email
          description: Recipient email address.
        name:
          type: string
          maxLength: 255
          title: Name
          description: Optional display name for this recipient.
          default: ''
        type:
          type: string
          enum:
            - to
            - cc
            - bcc
          title: Type
          description: Recipient delivery type.
          default: to
      type: object
      required:
        - email
      title: PlaybookScheduleEmailRecipientRequest
  securitySchemes:
    SummationMachineAuth:
      type: oauth2
      flows:
        clientCredentials:
          scopes:
            agent:read: agent:read
            agent:write: agent:write
          tokenUrl: /v1/auth/m2m/token

````