> ## 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.

# Scheduled report emails

> Email the PDF report of a folder or of a tool every month, every two weeks, every week or once, to people inside and outside woku

A **scheduled report** emails the PDF report of a **folder** (every tool of the folder and its subfolders) or of **one tool** (woku, NPS, CSAT or CES) to a list of recipients. Recipients need no woku account: it works for boards, managers or customers who want the report in their inbox without signing in.

## What the email carries

* The **PDF report** of the period: first a metrics page (responses, average, recognitions and improvements, sentiment, score distribution and word cloud), then the AI comment analysis.
* For a folder, the **CSV** of the responses of the period, if you turn it on.
* A **one-click unsubscribe** link. Whoever unsubscribes stops getting that company's reports; the rest of woku's emails do not change.

The email goes as your company, in Spanish or in English.

## Frequencies

| Frequency | When it goes out | Period it covers |
| - | - | - |
| Monthly | On the 1st, at 12:00 UTC | The whole previous month |
| Twice a month | On the 1st and 16th, at 12:00 UTC | The 16th to the end of the month, or the 1st to the 15th |
| Weekly | On Mondays, at 12:00 UTC | The previous week, Monday to Sunday |
| Just once | Now or on the date you choose | The period you choose (from and to) |

Each period goes out only once, even with several server instances. A failed send is recorded and not retried on its own; send it again with **Send now**.

## In the app

In the report of a **Tools** folder, or in the report of a woku, NPS, CSAT or CES, the **Schedule email** button opens a dialog with:

* The **list of scheduled emails** of that report, each with its next send or its status, and the actions **Send now**, **Pause** or **Resume**, **Edit** and **Delete**.
* The **form** to add one: frequency (with the date of the next send), recipients (up to 10 emails, separated by commas or on separate lines) and, for a folder, whether it attaches the CSV. For a **one-off** you choose the period and whether it goes out **now** or **on a date**.

Every scheduled email of the company is in **Company settings > Scheduled reports**, in a table with the report, frequency, recipients and status, with the same actions.

A one-off is not edited: delete it and create it again.

## API, SDK and MCP

* `GET /v1/report-subscriptions` lists them (optionally of one folder or tool, with `scopeType` and `scopeId`).
* `POST /v1/report-subscriptions` creates one: `scopeType` (`folder`, `woku`, `nps`, `csat` or `ces`), `scopeId`, `frequency` (`monthly`, `biweekly`, `weekly` or `once`), `recipients`, and optionally `includeCsv` and `locale`. A `once` email takes `periodFrom` and `periodTo` (ISO, `periodTo` exclusive) and `sendAt`; without `sendAt` it goes out within minutes.
* `PATCH /v1/report-subscriptions/:id` edits a recurring one, or pauses (`active: false`) and resumes it.
* `DELETE /v1/report-subscriptions/:id` deletes it.
* `POST /v1/report-subscriptions/:id/send` sends it now: the last complete period of a recurring one, or the own period of a one-off.

```ts JavaScript theme={null}
const monthly = await woku.reportSubscriptions.create({
  scopeType: 'folder',
  scopeId: folderId,
  frequency: 'monthly',
  recipients: ['board@company.com'],
  includeCsv: true,
});
await woku.reportSubscriptions.update(monthly.id, { active: false });
```

```python Python theme={null}
monthly = woku.report_subscriptions.create(
    {
        "scopeType": "folder",
        "scopeId": folder_id,
        "frequency": "monthly",
        "recipients": ["board@company.com"],
        "includeCsv": True,
    }
)
woku.report_subscriptions.update(monthly["id"], {"active": False})
```

The MCP server has `list_scheduled_reports`, `schedule_report`, `update_scheduled_report`, `delete_scheduled_report` and `send_scheduled_report_now`. See [MCP tools](/docs/en/mcp/tools).


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