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

# Delete

> Deletes one or several schedules. If you provide 'all' or 'future' as group action and if you allow it through 'allow_partial=true', only the schedules that come after team's lock date (if it exists) will be deleted.



## OpenAPI

````yaml preview post /api/schedule/schedules.delete
openapi: 3.1.0
info:
  title: tipee
  version: preview
servers: []
security:
  - basicAuth: []
tags:
  - name: Activity
    description: Activity
  - name: Balances
    description: Balances
  - name: Directory
    description: Directory
  - name: Schedule
    description: Schedule
  - name: Timeclock
    description: Timeclock
paths:
  /api/schedule/schedules.delete:
    post:
      tags:
        - Schedule
      summary: Delete
      description: >-
        Deletes one or several schedules. If you provide 'all' or 'future' as
        group action and if you allow it through 'allow_partial=true', only the
        schedules that come after team's lock date (if it exists) will be
        deleted.
      operationId: post_app_ui_api_schedule_schedulecommand_deleteschedules
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteSchedulesCommand'
      responses:
        '200':
          description: >-
            Schedule(s) deleted. When options.allow_partial is true, some
            schedules might not be deleted due to lock dates or permissions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteScheduleResult'
        '409':
          description: Warning to explain potential conflicts
          content:
            application/json:
              schema:
                properties:
                  warning_type:
                    type: string
                    example: locked_schedules
                  description:
                    type: string
                  details:
                    $ref: '#/components/schemas/DeleteSchedulesWarningDetails'
                  required_action:
                    type: string
                type: object
components:
  schemas:
    DeleteSchedulesCommand:
      required:
        - ids
        - options
      properties:
        ids:
          type: array
          items:
            $ref: '#/components/schemas/Snowflake'
        options:
          $ref: '#/components/schemas/DeleteOptions'
      type: object
    DeleteScheduleResult:
      description: Result of deleting schedule(s).
      required:
        - deleted_count
        - deleted
        - failed_count
        - failed
      properties:
        deleted_count:
          type: integer
        deleted:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        failed_count:
          type: integer
        failed:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
      type: object
    DeleteSchedulesWarningDetails:
      required:
        - schedules_to_delete_count
        - locked_schedules_count
        - locked_schedules_date_range
        - locked_teams
      properties:
        schedules_to_delete_count:
          type: integer
        locked_schedules_count:
          type: integer
        locked_schedules_date_range:
          $ref: '#/components/schemas/LocalDateInterval'
        locked_teams:
          type: array
          items:
            $ref: '#/components/schemas/LockedTeamInfo'
      type: object
    Snowflake:
      type: string
      format: snowflake
      example: '872815618512410358'
    DeleteOptions:
      required:
        - group_action
      properties:
        group_action:
          $ref: '#/components/schemas/GroupAction'
          description: If group action is 'single', allow_partial should not be provided
        allow_partial:
          description: >-
            Allows partial processing of the request for periods when the
            schedule is not locked and not overlapping
          type: boolean
      type: object
    LocalDateInterval:
      type: string
      format: local-date-interval
      example: 2019-11-11/2019-12-12
    LockedTeamInfo:
      required:
        - team_id
        - locked_date
      properties:
        team_id:
          type: integer
        locked_date:
          $ref: '#/components/schemas/LocalDate'
      type: object
    GroupAction:
      type: string
      example: single
      enum:
        - single
        - future
        - all
    LocalDate:
      type: string
      format: local-date
      example: '2019-11-11'

````