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

# Edit schedule

> Updates the fields sent; `shifts` replaces all shifts. Recalculates attendance for the assigned employees.

**Required permission:** `hr.schedules.write`



## OpenAPI

````yaml /api-reference/openapi.en.json put /hr/work-schedules/{id}
openapi: 3.0.3
info:
  title: FileXpress External API
  version: 1.0.0
  description: >-
    API for integrating third-party systems with FileXpress: billing, HR,
    accounting, inventory, projects, accounts receivable and payable, treasury,
    pricing and promotions, and cash. Current base URL: /api/external/v1. The
    legacy unversioned path (/api/external) will be removed on January 1, 2027;
    migrate to /api/external/v1 (same endpoints, only the base URL changes). The
    v2 API (/api/external/v2) exposes currencies and exchange rates, sales and
    purchases in foreign currency, taxes by id, payrolls with branch, and errors
    with a stable `code`; its operations carry the /v2 prefix in the path. We
    suggest migrating to the available v2 routes before March 30, 2027.
servers:
  - url: https://api.filexpress.app/api/external/v1
    description: Production
security:
  - ApiKey: []
tags:
  - name: General
  - name: Billing · Sales
  - name: Billing · Purchases
  - name: Billing · Customers
  - name: Billing · Suppliers
  - name: Billing · Products
  - name: Catalogs
  - name: HR · Employees
  - name: HR · Attendance
  - name: HR · Labor rules
  - name: HR · Schedules
  - name: HR · Holidays
  - name: HR · Attendance results
  - name: HR · Leave requests
  - name: HR · Payrolls
  - name: Accounting
  - name: Inventory
  - name: Projects
  - name: Accounts receivable
  - name: Accounts payable
  - name: Treasury
  - name: Pricing and promotions
  - name: Cash
  - name: Points of sale
  - name: API v2 · General
  - name: API v2 · Currencies and rates
  - name: API v2 · Countries
  - name: API v2 · Sales
  - name: API v2 · Purchases
  - name: API v2 · Payrolls
paths:
  /hr/work-schedules/{id}:
    put:
      tags:
        - HR · Schedules
      summary: Edit schedule
      description: >-
        Updates the fields sent; `shifts` replaces all shifts. Recalculates
        attendance for the assigned employees.


        **Required permission:** `hr.schedules.write`
      parameters:
        - name: id
          in: path
          required: true
          description: Schedule ID
          schema:
            type: string
            format: uuid
          example: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkScheduleUpdateRequest'
            example:
              name: Administrativo (verano)
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                status: true
                data:
                  id: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
                  business_id: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
                  name: Administrativo
                  code: ADM
                  description: Lunes a viernes
                  color: '#1890ff'
                  is_active: true
                  shifts:
                    - id: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
                      weekday: 1
                      start_time: '08:00'
                      end_time: '17:00'
                      break_minutes: 60
                      break_paid: null
                  weekly_minutes: 2400
                  days:
                    - weekday: 1
                      minutes: 480
                      shift_kind: day
                      warnings: []
                    - weekday: 7
                      minutes: 0
                      shift_kind: null
                      warnings: []
                  warnings: []
                  recalculation_queued: true
        '401':
          $ref: '#/components/responses/E401'
        '403':
          $ref: '#/components/responses/E403'
        '404':
          $ref: '#/components/responses/E404'
        '422':
          $ref: '#/components/responses/E422'
        '429':
          $ref: '#/components/responses/E429'
components:
  schemas:
    WorkScheduleUpdateRequest:
      type: object
      properties:
        name:
          type: string
        code:
          type: string
          description: Unique within the company.
        description:
          type: string
        color:
          type: string
        is_active:
          type: boolean
        shifts:
          type: array
          maxItems: 50
          items:
            type: object
            properties:
              weekday:
                type: integer
                minimum: 1
                maximum: 7
                description: 1 = Monday … 7 = Sunday.
              start_time:
                type: string
                pattern: ^([01]\d|2[0-3]):[0-5]\d$
              end_time:
                type: string
                pattern: ^([01]\d|2[0-3]):[0-5]\d$
                description: Less than or equal to start_time = ends the next day.
              break_minutes:
                type: integer
                minimum: 0
              break_paid:
                type: boolean
                nullable: true
            required:
              - weekday
              - start_time
              - end_time
  responses:
    E401:
      description: Missing or invalid API Key
      content:
        application/json:
          example:
            status: false
            message: Invalid API Key.
    E403:
      description: Integration without the required permission or deactivated
      content:
        application/json:
          example:
            status: false
            message: This integration does not have the 'hr.employees' permission.
            required_scope: hr.employees
    E404:
      description: Resource does not exist or belongs to another business
      content:
        application/json:
          example:
            status: false
            message: Not found.
    E422:
      description: Validation error
      content:
        application/json:
          example:
            status: false
            message: Validation errors
            errors:
              start_date:
                - The start date field is required.
    E429:
      description: Rate limit exceeded
      content:
        application/json:
          example:
            status: false
            message: Rate limit exceeded. Please try again later.
            rate_limit: 100
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Integration API Key (Integrations → New Integration).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.