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

# Reschedule a work

> Changes the date, time window or vehicle of a work. Send only the fields you want to change.
Requires the `works:write` scope.




## OpenAPI

````yaml /openapi.yaml put /works/{id}/schedule
openapi: 3.1.0
info:
  title: BeanRails Public API
  version: 1.0.0
  description: >
    Read and write BeanRails contacts, works, invoices, quotations and invoice
    payments from your own systems.

    Authenticate every request with an API key. See the guides for scopes,
    pagination and error handling.
servers:
  - url: https://{host}/api/public/v1
    description: Public API v1
    variables:
      host:
        default: app.beanrails.com
        description: The host your BeanRails workspace is served from.
security:
  - bearerAuth: []
tags:
  - name: Contacts
    description: Customers and leads.
  - name: Contact addresses
    description: Billing, shipping and service addresses of a contact.
  - name: Works
    description: Service or delivery jobs.
  - name: Work PODs
    description: Proof of delivery records submitted by drivers (read only).
  - name: Invoices
    description: Invoices, including status changes.
  - name: Quotations
    description: Quotations, including status changes.
  - name: Invoice payments
    description: Payments recorded against an invoice.
paths:
  /works/{id}/schedule:
    parameters:
      - $ref: '#/components/parameters/Id'
    put:
      tags:
        - Works
      summary: Reschedule a work
      description: >
        Changes the date, time window or vehicle of a work. Send only the fields
        you want to change.

        Requires the `works:write` scope.
      operationId: rescheduleWork
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                work_date:
                  type: string
                  format: date
                  description: New date, `YYYY-MM-DD`, in the workspace timezone.
                time_window_from:
                  type:
                    - string
                    - 'null'
                  description: >-
                    Start of the time window, `HH:mm`. Required with
                    `time_window_to`.
                time_window_to:
                  type:
                    - string
                    - 'null'
                  description: >-
                    End of the time window, `HH:mm`. Must be after
                    `time_window_from`.
                vehicle_id:
                  type:
                    - integer
                    - 'null'
                  description: Vehicle to assign, or `null` to unassign.
      responses:
        '200':
          description: The updated schedule of the work.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    Id:
      name: id
      in: path
      required: true
      description: The record ID.
      schema:
        type: integer
  responses:
    Unauthorized:
      description: The API key is missing, invalid, revoked or expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: invalid_api_key
              message: The API key is invalid, revoked, or expired.
    Forbidden:
      description: >-
        The key lacks the required scope, the key owner's role no longer allows
        it, or the owner's account is suspended.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: insufficient_scope
              message: This API key does not have the required scope.
    NotFound:
      description: The record does not exist, or your key is not allowed to see it.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: not_found
              message: The requested resource was not found.
    ValidationFailed:
      description: >-
        The request body failed validation. `error.fields` lists the problems
        per field.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationError'
          example:
            error:
              code: validation_failed
              message: The attention field is required.
              fields:
                attention:
                  - The attention field is required.
    RateLimited:
      description: >-
        You exceeded the key's requests per minute. Wait for the number of
        seconds in the `Retry-After` header.
      headers:
        Retry-After:
          description: Seconds until you can retry.
          schema:
            type: integer
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: A stable, machine readable code.
              examples:
                - not_found
            message:
              type: string
              description: A human readable explanation.
    ValidationError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - fields
          properties:
            code:
              type: string
              enum:
                - validation_failed
            message:
              type: string
            fields:
              type: object
              description: Field names mapped to a list of messages.
              additionalProperties:
                type: array
                items:
                  type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key created in BeanRails, for example `brk_live_...`.

````

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