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

# Update schedule report

> Update report type, company scope, frequency, and email recipients for a recurring Superadmin report export.



## OpenAPI

````yaml /api/superadmin.openapi.yaml put /schedule-reports/{scheduleExport}
openapi: 3.1.0
info:
  title: YouNegotiate Superadmin API
  version: '2.0'
  description: Stateless API endpoints for the Superadmin portal.
servers:
  - url: https://api.hub.younegotiate.com
    description: Production
security: []
tags:
  - name: System
    description: Public superadmin domain system and health endpoints.
  - name: Authentication
    description: Superadmin login, logout, password reset, and password change endpoints.
  - name: Profile
    description: Authenticated superadmin profile endpoints.
  - name: Admin Configuration
    description: Platform configuration values and feature flag controls.
  - name: MailHub Users
    description: Superadmin management for EcoMail Hub / EcoPortal users.
  - name: Super Admin Users
    description: Superadmin management for platform operations users.
  - name: Consumers
    description: Superadmin consumer account list, detail, filter, and export endpoints.
  - name: Creditors
    description: Superadmin creditor account list and account access endpoints.
  - name: Sub Accounts
    description: Superadmin sub account list and export endpoints.
  - name: Reseller Partners
    description: Superadmin reseller partner list and report-history endpoints.
  - name: Special Plan Inquiries
    description: >-
      Superadmin special membership inquiry list, detail, resolve, and close
      endpoints.
  - name: Plans
    description: >-
      Superadmin membership plan list, create, update, reorder, visibility, and
      delete endpoints.
  - name: Failed - Canceled
    description: Superadmin failed or cancelled membership list and custom email endpoints.
  - name: Merchant Requests
    description: >-
      Superadmin merchant API request list, export, email, forwarding, progress,
      and approval endpoints.
  - name: Bill Pay Donations
    description: Superadmin Bill Pay gift donation list, export, and receipt endpoints.
  - name: Export & Reporting
    description: Superadmin generated report options and CSV download endpoints.
  - name: Communications / Templates
    description: >-
      Superadmin email and SMS template management for manual communications and
      campaigns.
  - name: Communications / Groups
    description: >-
      Superadmin communication group management for dynamic consumer targeting
      and campaign selection.
  - name: Communications / Schedule Campaign
    description: >-
      Superadmin email and SMS campaign scheduling, immediate send, and delivery
      queue endpoints.
  - name: Communications / Campaign Tracker
    description: >-
      Superadmin campaign tracker snapshots, refresh actions, and consumer
      exports.
  - name: Automated Communications
    description: >-
      Superadmin automated email/SMS templates, trigger configuration, and
      delivery history endpoints.
paths:
  /schedule-reports/{scheduleExport}:
    parameters:
      - $ref: '#/components/parameters/ScheduleExportId'
    put:
      tags:
        - Export & Reporting
      summary: Update schedule report
      description: >-
        Update report type, company scope, frequency, and email recipients for a
        recurring Superadmin report export.
      operationId: superadminUpdateScheduleReport
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SuperadminScheduleReportMutationRequest'
      responses:
        '200':
          description: Schedule report updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuperadminScheduleReportMutationResponse'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - bearerAuth: []
components:
  parameters:
    ScheduleExportId:
      name: scheduleExport
      in: path
      required: true
      description: Scheduled report export ID.
      schema:
        type: integer
  schemas:
    SuperadminScheduleReportMutationRequest:
      type: object
      additionalProperties: false
      required:
        - report_type
        - frequency
        - delivery_type
        - emails
      properties:
        report_type:
          $ref: '#/components/schemas/SuperadminScheduleReportType'
        company_id:
          oneOf:
            - type: string
              enum:
                - all_members
            - type: integer
          nullable: true
          description: >-
            Use `all_members`, omit the field, or pass a company ID from the
            options endpoint.
          example: all_members
        frequency:
          $ref: '#/components/schemas/SuperadminScheduleReportFrequency'
        delivery_type:
          $ref: '#/components/schemas/SuperadminScheduleReportDeliveryType'
        emails:
          type: string
          description: Comma-separated list of up to five valid email addresses.
          example: reports@example.com, ops@example.com
    SuperadminScheduleReportMutationResponse:
      type: object
      additionalProperties: false
      required:
        - message
        - data
      properties:
        message:
          type: string
          example: Schedule report created.
        data:
          $ref: '#/components/schemas/SuperadminScheduleReport'
    SuperadminScheduleReportType:
      type: string
      enum:
        - bill_pay_donations_dfa
        - invoicing
        - cogs
        - partner_summary_total
        - partner_members
        - younegotiate_revenue
        - compliance_consumer_pii_opt_out
        - compliance_consumer_disputes_no_pay
        - compliance_auto_expired_deleted_accounts
        - consumer_payments
        - super_admin_all_accounts
    SuperadminScheduleReportFrequency:
      type: string
      enum:
        - daily
        - weekly
        - monthly
    SuperadminScheduleReportDeliveryType:
      type: string
      enum:
        - email
    SuperadminScheduleReport:
      type: object
      additionalProperties: false
      required:
        - id
        - company_id
        - subclient_id
        - sftp_connection_id
        - report_type
        - frequency
        - delivery_type
        - applied_to
        - emails
        - pause
      properties:
        id:
          type: integer
          example: 123
        company_id:
          type: integer
          nullable: true
          example: 45
        subclient_id:
          type: integer
          nullable: true
          example: null
        sftp_connection_id:
          type: integer
          nullable: true
          example: null
        report_type:
          type: object
          additionalProperties: false
          required:
            - value
            - label
            - requires_date_range
          properties:
            value:
              $ref: '#/components/schemas/SuperadminScheduleReportType'
            label:
              type: string
              example: Super Admin Report - All Accounts
            requires_date_range:
              type: boolean
              example: true
        frequency:
          type: object
          additionalProperties: false
          required:
            - value
            - label
          properties:
            value:
              $ref: '#/components/schemas/SuperadminScheduleReportFrequency'
            label:
              type: string
              example: Weekly
        delivery_type:
          type: object
          additionalProperties: false
          required:
            - value
            - label
          properties:
            value:
              $ref: '#/components/schemas/SuperadminScheduleReportDeliveryType'
            label:
              type: string
              example: Email
        applied_to:
          $ref: '#/components/schemas/SuperadminScheduleReportCompanyScope'
        emails:
          type: array
          items:
            type: string
            format: email
          example:
            - reports@example.com
            - ops@example.com
        sftp_connection:
          type: 'null'
          description: >-
            Superadmin scheduled reports are email-only, so no SFTP connection
            is returned.
          example: null
        pause:
          type: boolean
          example: false
        last_sent_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
    MessageResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
    ValidationErrorResponse:
      type: object
      required:
        - message
        - errors
      properties:
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
    SuperadminScheduleReportCompanyScope:
      type: object
      additionalProperties: false
      required:
        - value
        - label
      properties:
        value:
          oneOf:
            - type: string
              enum:
                - all_members
            - type: integer
          example: all_members
        label:
          type: string
          example: All Members
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
    ValidationError:
      description: Request validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum token

````