Sign in

v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Report Schedules

Update a report schedule

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.

patch/api/v2/reporting/schedule/{schedule_uuid}

Path parameters

schedule_uuidstring uuid required

The unique identifier of the report schedule to update.

Request body

Example request

{
  "data": {
    "attributes": {
      "delivery_format": "pdf",
      "description": "Updated weekly summary of infrastructure health.",
      "recipients": [
        "user@example.com",
        "slack:T01234567.C01234567.alerts",
        "teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:exampleChannelId@thread.tacv2"
      ],
      "rrule": "DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0",
      "tab_id": "66666666-7777-8888-9999-000000000000",
      "template_variables": [
        {
          "name": "env",
          "values": [
            "prod"
          ]
        }
      ],
      "timeframe": "1w",
      "timezone": "America/New_York",
      "title": "Weekly Infrastructure Report"
    },
    "type": "schedule"
  }
}

Response

OK

Example response

{
  "data": {
    "attributes": {
      "delivery_format": "pdf",
      "description": "Weekly summary of infrastructure health.",
      "next_recurrence": 1780923600000,
      "recipients": [
        "user@example.com",
        "slack:T01234567.C01234567.alerts",
        "teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:exampleChannelId@thread.tacv2"
      ],
      "resource_id": "abc-def-ghi",
      "resource_type": "dashboard",
      "rrule": "DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0",
      "status": "active",
      "tab_id": "66666666-7777-8888-9999-000000000000",
      "template_variables": [
        {
          "name": "env",
          "values": [
            "prod"
          ]
        }
      ],
      "timeframe": "1w",
      "timezone": "America/New_York",
      "title": "Weekly Infrastructure Report"
    },
    "id": "11111111-2222-3333-4444-555555555555",
    "relationships": {
      "author": {
        "data": {
          "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
          "type": "users"
        }
      }
    },
    "type": "schedule"
  },
  "included": [
    {
      "attributes": {
        "email": "user@example.com",
        "name": "Example User"
      },
      "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "type": "users"
    }
  ]
}