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

# Update a template

> Updates a template's file, output format, or description.



## OpenAPI

````yaml en/openapi/v3-current/reporter.yaml patch /v1/templates/{id}
openapi: 3.1.0
info:
  contact:
    name: Discord community
    url: https://discord.gg/DnhqKwkGv3
  description: >-
    This is OpenAPI documentation for Reporter. The unified reporter binary
    serves the REST API (RUN_MODE=api) and/or the RabbitMQ report-generation
    worker (RUN_MODE=worker); RUN_MODE=all runs both in one process for local
    development. All REST endpoints documented here serve only when RUN_MODE=api
    or all (port :4005); the worker (port :4006) exposes health/readyz only.
  license:
    name: Lerian Studio General License
  title: Midaz Reporter API
  version: 4.0.0
servers:
  - url: http://localhost:4005
  - url: https://localhost:4005
security:
  - BearerAuth: []
tags:
  - description: Generated report instances and their lifecycle.
    name: Reports
  - description: Reusable report definitions.
    name: Templates
  - description: Interactive construction of report templates.
    name: Template Builder
  - description: Scheduled report due-date tracking.
    name: Deadlines
  - description: Configured inputs that feed report data.
    name: Data Sources
  - description: Aggregated reporting metrics.
    name: Metrics
  - description: Published business event catalog and delivery policies.
    name: Streaming
paths:
  /v1/templates/{id}:
    patch:
      tags:
        - Templates
      summary: Update a template
      description: Updates a template's file, output format, or description.
      operationId: updateTemplate
      parameters:
        - description: Template ID
          example: 00000000-0000-0000-0000-000000000000
          in: path
          name: id
          required: true
          schema:
            description: Template ID
            type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                description:
                  description: Human-readable template description
                  examples:
                    - Monthly financial report
                  type: string
                outputFormat:
                  description: Generated report output format
                  examples:
                    - html
                  type: string
                template:
                  contentMediaType: application/octet-stream
                  description: Pongo2 template file
                  examples:
                    - monthly-report.tpl
                  format: binary
                  type: string
              type: object
        description: Template multipart form
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateResponse'
          description: OK
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Bad Request
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Forbidden
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Not Found
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error
components:
  schemas:
    TemplateResponse:
      properties:
        createdAt:
          description: Template creation timestamp in UTC
          examples:
            - '2021-01-01T00:00:00Z'
          format: date-time
          type: string
        description:
          description: Human-readable template description
          examples:
            - Monthly financial report
          type: string
        fileName:
          description: Stored template filename
          examples:
            - 0196159b-4f26-7300-b3d9-f4f68a7c85f3_1744119295.tpl
          type: string
        id:
          description: Unique template identifier
          examples:
            - 00000000-0000-0000-0000-000000000000
          type: string
        outputFormat:
          description: Format generated from this template
          examples:
            - HTML
          type: string
        updatedAt:
          description: Most recent template update timestamp in UTC
          examples:
            - '2021-01-01T00:00:00Z'
          format: date-time
          type: string
        warnings:
          description: >-
            Non-fatal mapped-field validation warnings returned when a data
            source is unavailable
          examples:
            - - code: DATA_SOURCE_UNAVAILABLE
                field: account.balance
                message: data source is temporarily unavailable
          items:
            $ref: '#/components/schemas/ValidationWarning'
          type:
            - array
            - 'null'
      type: object
    Detail:
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          examples:
            - - location: body.templateId
                message: expected string to match 'uuid' format
                value: not-a-uuid
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    ValidationWarning:
      properties:
        code:
          description: Machine-readable warning code.
          examples:
            - DATA_SOURCE_UNAVAILABLE
          type: string
        field:
          description: Field or data source reference affected by the warning.
          examples:
            - customers.email
          type: string
        message:
          description: Human-readable description of the warning.
          examples:
            - Data source is temporarily unavailable.
          type: string
      type: object
    ErrorDetail:
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          examples:
            - body.templateId
          type: string
        message:
          description: Error message text
          examples:
            - expected string to match 'uuid' format
          type: string
        value:
          description: The value at the given location
          examples:
            - not-a-uuid
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````