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

# Save report automation settings

> Create or update the automation schedule for a report. When enabled with recipients, a BullMQ repeatable job is created. When disabled, the schedule is removed.



## OpenAPI

````yaml https://api.surnex.io/openapi.json put /v1/projects/{project_id}/reports/{report_id}/automation
openapi: 3.1.0
info:
  title: Surnex API
  description: |-
    Surnex SEO Platform API — api.surnex.io

    Provides the complete backend for the Surnex SEO dashboard including:
    - Multi-tenant organization management
    - Project tracking (domains)
    - Keyword rank tracking (Phase 1+)
    - Backlink analysis (Phase 3+)
    - Site auditing (Phase 4+)
    - Stripe billing integration
    - MCP endpoint for AI agents at /mcp
  version: 0.1.0
servers: []
security: []
paths:
  /v1/projects/{project_id}/reports/{report_id}/automation:
    put:
      tags:
        - Reports
      summary: Save report automation settings
      description: >-
        Create or update the automation schedule for a report. When enabled with
        recipients, a BullMQ repeatable job is created. When disabled, the
        schedule is removed.
      operationId: >-
        save_automation_v1_projects__project_id__reports__report_id__automation_put
      parameters:
        - name: project_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Project Id
        - name: report_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Report Id
        - name: X-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportAutomationUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponse_ReportAutomationResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    ReportAutomationUpdate:
      properties:
        enabled:
          type: boolean
          title: Enabled
        frequency:
          type: string
          title: Frequency
          description: 'Schedule frequency: ''daily'', ''weekly'', ''biweekly'', or ''monthly''.'
        hour:
          type: integer
          maximum: 23
          minimum: 0
          title: Hour
          description: Hour of day (0-23).
        timezone:
          type: string
          maxLength: 50
          title: Timezone
          default: UTC
        recipients:
          items:
            type: string
          type: array
          title: Recipients
      type: object
      required:
        - enabled
        - frequency
        - hour
      title: ReportAutomationUpdate
      description: Request body for updating report automation settings.
    APIResponse_ReportAutomationResponse_:
      properties:
        success:
          type: boolean
          title: Success
          default: true
        data:
          anyOf:
            - $ref: '#/components/schemas/ReportAutomationResponse'
            - type: 'null'
      type: object
      title: APIResponse[ReportAutomationResponse]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ReportAutomationResponse:
      properties:
        enabled:
          type: boolean
          title: Enabled
        frequency:
          anyOf:
            - type: string
            - type: 'null'
          title: Frequency
        hour:
          type: integer
          title: Hour
        timezone:
          type: string
          title: Timezone
        recipients:
          items:
            type: string
          type: array
          title: Recipients
      type: object
      required:
        - enabled
        - hour
        - timezone
        - recipients
      title: ReportAutomationResponse
      description: Response schema for report automation settings.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````