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

# Programar el envío de un reporte por correo

> Envía por correo el reporte PDF de una carpeta (todas las herramientas de su subárbol, opcionalmente con el CSV) o de una herramienta a hasta 10 destinatarios fuera de woku. monthly (día 1), biweekly (días 1 y 16) y weekly (lunes) salen a las 12:00 UTC con el período anterior completo; once sale en sendAt (o ahora) con periodFrom/periodTo. Cada correo sale a nombre de la empresa y trae un enlace de baja en un clic.



## OpenAPI

````yaml /openapi-v1.es.json post /v1/report-subscriptions
openapi: 3.0.0
info:
  title: Woku Client API v1
  description: >-
    API REST pública para la administración programática de programas
    Voice-of-Customer de woku: trackers, instrumentos VoC (NPS, woku, CES,
    CSAT), planes de acción, tickets de soporte, envío multicanal y captura de
    respuestas. Las solicitudes están delimitadas por empresa mediante la clave
    API. Nunca envíe un id de empresa.
  version: 1.0.0
  contact:
    name: Woku
    url: https://woku.app
    email: team@woku.app
servers:
  - url: https://clientapi.woku.app
    description: Producción
security: []
tags: []
paths:
  /v1/report-subscriptions:
    post:
      tags:
        - v1 - envíos programados de reportes
      summary: Programar el envío de un reporte por correo
      description: >-
        Envía por correo el reporte PDF de una carpeta (todas las herramientas
        de su subárbol, opcionalmente con el CSV) o de una herramienta a hasta
        10 destinatarios fuera de woku. monthly (día 1), biweekly (días 1 y 16)
        y weekly (lunes) salen a las 12:00 UTC con el período anterior completo;
        once sale en sendAt (o ahora) con periodFrom/periodTo. Cada correo sale
        a nombre de la empresa y trae un enlace de baja en un clic.
      operationId: V1ReportSubscriptionsController_create
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateReportSubscriptionDTO'
      responses:
        '201':
          description: Envío programado creado
        '400':
          description: Error de validación
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponseDto'
        '404':
          description: Carpeta o herramienta no encontrada
      security:
        - bearer: []
components:
  schemas:
    CreateReportSubscriptionDTO:
      type: object
      properties:
        scopeType:
          type: string
          enum:
            - folder
            - woku
            - nps
            - csat
            - ces
        scopeId:
          type: string
          description: Id de la carpeta o herramienta
          format: ObjectId
        frequency:
          type: string
          enum:
            - monthly
            - biweekly
            - weekly
            - once
          description: >-
            monthly (día 1), biweekly (días 1 y 16), weekly (lunes) a las 12:00
            UTC con el período anterior completo, u once
        recipients:
          description: Correos de los destinatarios, de 1 a 10; no necesitan cuenta en woku
          type: array
          items:
            type: string
        includeCsv:
          type: boolean
          description: 'Solo carpetas: adjunta también el CSV'
        locale:
          type: string
          enum:
            - es
            - en
          default: es
        sendAt:
          type: string
          description: 'Solo once: cuándo enviarlo (ISO); sin valor = ahora'
        periodFrom:
          type: string
          description: 'Solo once: inicio del período (ISO)'
        periodTo:
          type: string
          description: 'Solo once: fin del período (ISO, exclusivo)'
      required:
        - scopeType
        - scopeId
        - frequency
        - recipients
    ValidationErrorResponseDto:
      type: object
      properties:
        statusCode:
          type: number
          description: Código de estado HTTP
          example: 400
        message:
          description: Arreglo de mensajes de error de validación
          example:
            - email must be a valid email
            - password must be at least 8 characters
          type: array
          items:
            type: string
        error:
          type: string
          description: Tipo de error
          example: Bad Request
      required:
        - statusCode
        - message
        - error
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: API key
      type: http
      description: Clave API secreta de la empresa.

````

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