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

# Save mailback automation schedule

> Replaces the tenant's schedule: which reports to request, IMMEDIATE or OVERNIGHT, and the IST time and weekdays to run. A background job queues the requests once the time has passed, at most once per day.



## OpenAPI

````yaml /openapi.yaml put /api/mailback-automation/v1/sources/{source}/config
openapi: 3.0.3
info:
  title: MF Atlas API
  version: 1.0.0
servers:
  - description: Sandbox
    url: https://api-sandbox.mf-atlas.space
  - description: Production
    url: https://api.mf-atlas.space
security:
  - bearerAuth: []
paths:
  /api/mailback-automation/v1/sources/{source}/config:
    put:
      tags:
        - mailback-automation
      summary: Save mailback automation schedule
      description: >-
        Replaces the tenant's schedule: which reports to request, IMMEDIATE or
        OVERNIGHT, and the IST time and weekdays to run. A background job queues
        the requests once the time has passed, at most once per day.
      parameters:
        - description: Report source. Only cams today.
          in: path
          name: source
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                days:
                  description: >-
                    Days of the week to run on (MON..SUN). Empty means every
                    day.
                  items:
                    type: string
                  type: array
                enabled:
                  description: >-
                    Whether the schedule runs. A disabled schedule is kept but
                    never fires.
                  type: boolean
                reports:
                  description: >-
                    Report codes to request on every run, e.g. WBR53. Must be
                    among available_reports.
                  items:
                    type: string
                  type: array
                run_at:
                  description: Time of day to request the reports, HH:MM in IST (24-hour).
                  type: string
                timing:
                  description: >-
                    IMMEDIATE (the RTA mails the report within minutes) or
                    OVERNIGHT.
                  type: string
              required:
                - enabled
                - reports
                - run_at
                - timing
              type: object
        description: Schedule
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    properties:
                      available_reports:
                        description: Report codes that can be requested for this source.
                        items:
                          type: string
                        type: array
                      days:
                        items:
                          type: string
                        type: array
                      enabled:
                        type: boolean
                      last_enqueued_on:
                        description: >-
                          IST date (YYYY-MM-DD) the schedule last queued its
                          reports. Read-only.
                        type: string
                      reports:
                        items:
                          type: string
                        type: array
                      run_at:
                        type: string
                      source:
                        description: The report source. Only cams today.
                        type: string
                      timing:
                        type: string
                      updated_at:
                        type: string
                    required:
                      - available_reports
                      - days
                      - enabled
                      - reports
                      - run_at
                      - source
                      - timing
                    type: object
                  success:
                    type: boolean
                required:
                  - success
                type: object
          description: Saved schedule
components:
  securitySchemes:
    bearerAuth:
      bearerFormat: Opaque bearer token from POST /api/auth/v1/token
      scheme: bearer
      type: http

````

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