v1

latestOpenAPI 3.0.32026-07-26120117318.1 KB

Scheduled Reports

Update scheduled report

Partially update a scheduled report. Omit any field to keep its current value; at least one field must be supplied.

put/scheduled-reports/{report_id}

Path parameters

report_idstring required

Request body

report_namestring

send_atstring

included_range_days1 | 3 | 7

status'draft' | 'active'

environment'sandbox' | 'production'

Example request

{
  "destinations": [
    {
      "type": "target_integration",
      "id": "int-wh-01",
      "label": "Webhooks: Release alerts"
    }
  ]
}

Response

Updated scheduled report.

objectstring required

idstring required

Report identifier.

urlstring required

report_namestring required

Human-readable name, 1-255 chars.

send_atstring required

UTC time-of-day for the daily delivery, HH:MM format, aligned to 30-minute slots. Valid values range from "00:00" to "23:30".

included_range_days1 | 3 | 7 required

Coverage window in whole days — one of 1, 3, 7.

status'draft' | 'active' required

draft — paused, no deliveries. active — enqueued for delivery at each send_at.

environment'sandbox' | 'production' required

runsinteger required

Number of deliveries completed so far.

created_atstring date-time required

updated_atstring date-time required

Example response

{
  "object": "scheduled_report",
  "id": "wbRlfw1x",
  "url": "/v4/scheduled-reports/wbRlfw1x",
  "report_name": "Daily Revenue",
  "send_at": "09:00",
  "included_range_days": 1,
  "status": "active",
  "environment": "production",
  "runs": 14,
  "destinations": [
    {
      "type": "target_integration",
      "id": "int-wh-01",
      "label": "Webhooks: Release alerts"
    }
  ],
  "created_at": "2026-04-23T11:44:36Z",
  "updated_at": "2026-04-23T11:44:36Z"
}