--- title: "Update a report schedule" method: PATCH path: "/api/v2/reporting/schedule/{schedule_uuid}" tags: ["Report Schedules"] --- # Update a report schedule `PATCH /api/v2/reporting/schedule/{schedule_uuid}` ## Request - Base URL: `https://api.datadoghq.com` - URL: `https://api.datadoghq.com/api/v2/reporting/schedule/{schedule_uuid}` - Auth: API key in header `DD-API-KEY` and API key in header `DD-APPLICATION-KEY` Update an existing scheduled report by its identifier. The editable attributes are replaced with the supplied values; the targeted resource (`resource_id` and `resource_type`) cannot be changed after creation. Requires the `generate_dashboard_reports` permission and schedule ownership. ## Path parameters - `schedule_uuid` string, uuid, required ## Request body - ReportSchedulePatchRequest: Request body for updating a report schedule. - `data` ReportSchedulePatchRequestData, required: The JSON:API data object for a report schedule update request. - `attributes` ReportSchedulePatchRequestAttributes, required: The updated configuration of the report schedule. These values replace the existing ones; the targeted resource (`resource_id` and `resource_type`) cannot be changed. - `delivery_format` 'pdf' | 'png' | 'pdf_and_png': How a PDF-export report is delivered. `pdf` attaches a PDF file, `png` embeds an inline PNG image, and `pdf_and_png` delivers both. - `description` string, required: A description of the report, up to 4096 characters. - `recipients` string[], required: The recipients of the report. Each entry is an email address, a Slack channel reference in the form `slack:{team_id}.{channel_id}.{channel_name}`, or a Microsoft Teams channel reference in the form `teams:{tenant_id}|{team_id}|{channel_id}`. - `rrule` string, required: The recurrence rule for the schedule, expressed as an iCalendar `RRULE` string. - `tab_id` string, uuid: The identifier of the dashboard tab to render, when the dashboard has tabs. - `template_variables` ReportScheduleTemplateVariable[], required: The dashboard template variables applied when rendering the report. - `name` string, required: The name of the template variable. - `values` string[], required: The selected values for the template variable. - `timeframe` string, required: The relative timeframe of data to include in the report. - `timezone` string, required: The IANA time zone identifier the recurrence rule is evaluated in. - `title` string, required: The title of the report, between 1 and 78 characters. - `type` 'schedule', required: JSON:API resource type for report schedules. ## Response `200` OK - ReportScheduleResponse: Response containing a single report schedule. - `data` ReportScheduleResponseData, required: The JSON:API data object representing a report schedule. - `attributes` ReportScheduleResponseAttributes, required: The configuration and derived state of a report schedule. - `delivery_format` 'pdf' | 'png' | 'pdf_and_png', nullable: The delivery format for dashboard report schedules, or `null` if not set. - `description` string, required: The description of the report. - `next_recurrence` integer, nullable, required: The Unix timestamp, in milliseconds, of the next scheduled delivery, or `null` if none is scheduled. - `recipients` string[], required: The recipients of the report (email addresses, Slack channel references, or Microsoft Teams channel references). - `resource_id` string, required: The identifier of the resource rendered in the report. - `resource_type` 'dashboard' | 'integration_dashboard', required: The type of dashboard resource the report schedule targets. - `rrule` string, required: The recurrence rule for the schedule, expressed as an iCalendar `RRULE` string. - `status` 'active' | 'inactive', required: Whether the schedule is currently delivering reports (`active`) or paused (`inactive`). - `tab_id` string, nullable, required: The identifier of the dashboard tab rendered in the report, or `null` if not set. - `template_variables` ReportScheduleTemplateVariable[], required: The dashboard template variables applied when rendering the report. - `name` string, required: The name of the template variable. - `values` string[], required: The selected values for the template variable. - `timeframe` string, nullable, required: The relative timeframe of data included in the report, or `null` if not set. - `timezone` string, required: The IANA time zone identifier the recurrence rule is evaluated in. - `title` string, required: The title of the report. - `id` string, required: The unique identifier of the report schedule. - `relationships` ReportScheduleResponseRelationships, required: Relationships for the report schedule. - `author` ReportScheduleAuthorRelationship, required: Relationship to the author of the report schedule. - `data` ReportScheduleAuthorRelationshipData, required: Relationship data for the author of the report schedule. - `id` string, required: The user UUID of the report schedule author. - `type` 'users', required: JSON:API resource type for the included report author. - `type` 'schedule', required: JSON:API resource type for report schedules. - `included` ReportScheduleIncludedResource[]: Related resources included with the report schedule, such as the author. - union: A related resource included with a report schedule. - ReportScheduleAuthor: A user included as a related JSON:API resource. - `attributes` ReportScheduleAuthorAttributes, required: Attributes of the report author. - `email` string, nullable, required: The email address of the report author, or `null` if unavailable. - `name` string, nullable, required: The display name of the report author, or `null` if unavailable. - `id` string, required: The user UUID. - `type` 'users', required: JSON:API resource type for the included report author. - ReportScheduleResource: A report target resource included as a related JSON:API resource. - `attributes` ReportScheduleResourceAttributes, required: Attributes of an included report target resource. - `resource_type` 'dashboard' | 'integration_dashboard', required: The type of dashboard resource the report schedule targets. - `template_variables` ReportScheduleIndexTemplateVariable[], nullable: Template variable metadata from the dashboard resource, when available. - `available_values` string[], nullable: Available values for the template variable. - `defaults` string[], nullable: Default values for the template variable. - `name` string, nullable: The template variable name. - `prefix` string, nullable: The tag prefix for the template variable, when available. - `title` string, nullable: The title of the dashboard or integration dashboard resource, when available. - `id` string, required: The resource identifier. - `type` 'resource', required: JSON:API resource type for an included report resource. ## Other responses - `400`: Bad Request - `403`: Forbidden - `404`: Not Found - `429`: Too many requests --- [API](https://skmtc.dev/datadog/apis/datadog-api-v2-collection.md) - [All operations](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/llms.txt) - [OpenAPI document](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/revisions/da68bf029e4c?raw)