---
title: "ScheduledReports"
method: POST
path: "/workspaces/{workspace_id}/scheduled_reports"
tags: ["reports"]
---

# ScheduledReports

`POST /workspaces/{workspace_id}/scheduled_reports`

## Request

- Base URL: `https://localhost:8080/api/v9`
- URL: `https://localhost:8080/api/v9/workspaces/{workspace_id}/scheduled_reports`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/toggl/apis/toggl-api/docs/workspaces/:workspace_id/scheduled_reports/post.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint for setting up a scheduled report.

## Path parameters

- `workspace_id` integer, required

## Request body

- ScheduledPayload
  - `bookmark_id` integer
  - `frequency` integer
  - `group_ids` integer[]
  - `user_ids` integer[]

## Response `200`

Returns created schedule report.

- ModelsScheduledReport
  - `bookmark_id` integer
  - `created_at` string
  - `creator_id` integer
  - `deleted_at` string
  - `frequency` integer
  - `group_ids` integer[]
  - `report_id` integer
  - `user_ids` integer[]
  - `workspace_id` integer

## Other responses

- `400`: Possible error messages: <ul><li>Bookmark not found.</li><li>Unable to use all requested recipients.</li><li>No usable recipients found.</li><li>Invalid scheduled report frequency. Must be one of: 1 (daily), 7 (weekly) or 30 (monthly).</li></ul>
- `402`: Workspace needs to have the {feature_name} feature enabled.
- `403`: User does not have access to this resource.
- `404`: Workspace not found/accessible
- `500`: Internal Server Error

---

[API](https://skmtc.dev/toggl/apis/toggl-api.md) - [All operations](https://skmtc.dev/toggl/apis/toggl-api/llms.txt) - [OpenAPI document](https://skmtc.dev/toggl/apis/toggl-api/revisions/3085aee16990?raw)