Update a report schedule

Replaces a report schedule's cadence, recipients, report type, language, timezone and frozen report parameters.

PUT https://app.upfour.io/v1/reports/schedules/{scheduleID}

A real request. Sending it changes data in your up4 account.

Authorization

AuthorizationA pls_ key. It stays in this browser tab. Needs report.write.

Path

scheduleIDpath · requiredPart of the request path.

Body

cadencerequired

namerequired 1 to 200 characters without line breaks. report_typerequired

Timing4

day_of_week Required for weekly: 1 (Monday) to 7 (Sunday). day_of_month Required for monthly: 1 to 28. send_hour Hour of the day, 0 to 23, in timezone. 0 when omitted. timezone IANA time zone; UTC when omitted.

Delivery3

format Defaults to pdf.

language en or de (a region such as de-DE or the language name is accepted); null or empty inherits from the client, then the Company.

enabled true when omitted, on update too.

Scope and parameters1

client_id Report on one client; omitted means the Company level. On update, omitting it keeps the schedule's client.

2 more fields are only available in JSON.

Sent directly from your browser to https://app.upfour.io/v1. Mutating calls get an automatic Idempotency-Key when the field is empty.

Request

Responsenot sent yet

Fill in a key and press Send request (⌘↵).
The answer appears here.

scope report.write stable returns 200

Parameters

Field	Type	Description
`scheduleID` required	uuid	path parameter

Body

The 4 fields most calls use come first; the rest are grouped below.

application/json required 13 fields

namestringrequired

1 to 200 characters without line breaks.

In the app: Name

report_typestringrequired

executive_summarysummarymonitor_reportmonitorsmonitor_slaslaincident_analyticsincidentsresponse_timeresponse-timedowntime_ledgerdowntime-ledgertrends

In the app: Report

cadencestringrequired

weeklymonthly

In the app: Cadence

recipientsstring (email)[]required

1 to 50 distinct email addresses.

In the app: Recipients

Timing4 fields

day_of_weekinteger · nullable

Required for weekly: 1 (Monday) to 7 (Sunday).

day_of_monthinteger · nullable

Required for monthly: 1 to 28.

In the app: Day of month

send_hourinteger

Hour of the day, 0 to 23, in timezone. 0 when omitted.

In the app: Send at (hour)

timezonestring

IANA time zone; UTC when omitted.

In the app: Timezone

Delivery3 fields

formatstring

Defaults to pdf.

csvjsonpdfxlsx

In the app: Format

languagestring · nullable

en or de (a region such as de-DE or the language name is accepted); null or empty inherits from the client, then the Company.

In the app: Report language

enabledboolean · nullable

true when omitted, on update too.

Scope and parameters2 fields

client_iduuid · nullable

Report on one client; omitted means the Company level. On update, omitting it keeps the schedule's client.

In the app: Scope to client (optional)

paramsobjectfree-form keys

Frozen report parameters: preset, from and to (the window, as in the query of the report endpoints), target (SLA target in percent, above 0 up to 100) and filters (monitor, severity and search narrowing; region, tag and group filters are refused). Without a window a weekly schedule reports the last 7 days and a monthly one the previous month.

Returns

A successful request returns 200 with application/json.

Response fields 1 top-level fields

Field Type Description

data ReportSchedule

ReportSchedule · 21 fields

Field	Type	Description
`cadence`	string one of`weeklymonthly`
`created_at`	string (date-time)
`enabled`	boolean
`format`	string one of`csvjsonpdfxlsx`
`id`	uuid
`language`	string · nullable one of`ende`	null when the schedule inherits.
`name`	string
`next_run_at`	string (date-time)
`organization_id`	uuid
`params`	object · nullable free-form keys	The frozen report parameters; see the request.
`recipients`	string[] · nullable
`report_type`	string one of`executive_summarysummarymonitor_reportmonitorsmonitor_slaslaincident_analyticsincidentsresponse_timeresponse-timedowntime_ledgerdowntime-ledgertrends`
`send_hour`	integer
`timezone`	string
`updated_at`	string (date-time)
`client_id`	uuid
`created_by`	uuid
`day_of_month`	integer
`day_of_week`	integer
`effective_language`	string one of`ende`	The language the schedule renders in now.
`last_run_at`	string (date-time)

Errors

Only the errors this operation can return. Every error uses the same envelope.

Status	Code	Meaning
400	`bad_request`	The request is malformed or fails validation.
402	`billing_action_unavailable`	The Company's billing state does not allow this action. When: A metered or limited action while the billing state, such as paused or without credit, blocks it; details holds the action and billing_state. Fix: Top up the credit or change the plan, then retry.
404	`not_found`	The requested resource does not exist or is outside the caller's scope.
403	`permission_denied`	The credentials do not permit this action.
503	`quota_gate_unavailable`	The limit check itself failed, so the action was not carried out. When: The quota service could not decide while the request ran. Fix: Retry in a moment; nothing was changed.
403 / 429	`quota_limit_reached`	A usage or inventory limit of the Company was reached. When: Counters and concurrency limits answer 429 with Retry-After, inventory and capacity limits answer 403; details holds purpose, limit and window. Fix: On 429 wait Retry-After seconds; on 403 free something up, request a higher limit where details.raise_request is true, or buy an extension.

Every call can also return unauthorized (401), rate_limit_exceeded (429) or internal_error (500 / 502). See Responses and errors.

curl -s -X PUT "https://app.upfour.io/v1/reports/schedules/00000000-0000-4000-8000-000000000001" \ -H "Authorization: Bearer $UP4_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "cadence": "weekly", "day_of_week": 1, "enabled": true, "format": "pdf", "language": "en", "name": "Weekly summary", "recipients": [ "anna@example.com" ], "report_type": "summary", "send_hour": 9, "timezone": "Europe/Berlin" }'

const res = await fetch("https://app.upfour.io/v1/reports/schedules/00000000-0000-4000-8000-000000000001", { method: "PUT", headers: { Authorization: `Bearer ${process.env.UP4_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ cadence: "weekly", day_of_week: 1, enabled: true, format: "pdf", language: "en", name: "Weekly summary", recipients: ["anna@example.com"], report_type: "summary", send_hour: 9, timezone: "Europe/Berlin", }), }); console.log(res.status, await res.json());

import os import requests res = requests.put( "https://app.upfour.io/v1/reports/schedules/00000000-0000-4000-8000-000000000001", headers={"Authorization": f"Bearer {os.environ['UP4_API_KEY']}"}, json={ "cadence": "weekly", "day_of_week": 1, "enabled": True, "format": "pdf", "language": "en", "name": "Weekly summary", "recipients": ["anna@example.com"], "report_type": "summary", "send_hour": 9, "timezone": "Europe/Berlin", }, ) print(res.status_code, res.json())

package main import ( "fmt" "io" "net/http" "os" "strings" ) func main() { payload := strings.NewReader(`{ "cadence": "weekly", "day_of_week": 1, "enabled": true, "format": "pdf", "language": "en", "name": "Weekly summary", "recipients": [ "anna@example.com" ], "report_type": "summary", "send_hour": 9, "timezone": "Europe/Berlin" }`) req, _ := http.NewRequest("PUT", "https://app.upfour.io/v1/reports/schedules/00000000-0000-4000-8000-000000000001", payload) req.Header.Set("Authorization", "Bearer "+os.Getenv("UP4_API_KEY")) req.Header.Set("Content-Type", "application/json") res, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer res.Body.Close() out, _ := io.ReadAll(res.Body) fmt.Println(res.StatusCode, string(out)) }

<?php $payload = <<<'JSON' { "cadence": "weekly", "day_of_week": 1, "enabled": true, "format": "pdf", "language": "en", "name": "Weekly summary", "recipients": [ "anna@example.com" ], "report_type": "summary", "send_hour": 9, "timezone": "Europe/Berlin" } JSON; $ch = curl_init("https://app.upfour.io/v1/reports/schedules/00000000-0000-4000-8000-000000000001"); curl_setopt_array($ch, [ CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ "Authorization: Bearer " . getenv("UP4_API_KEY"), "Content-Type: application/json", ], CURLOPT_POSTFIELDS => $payload, ]); $response = curl_exec($ch); echo curl_getinfo($ch, CURLINFO_RESPONSE_CODE), " ", $response, "\n"; curl_close($ch);

{ "data": { "cadence": "weekly", "created_at": "2026-10-27T09:00:00Z", "created_by": "00000000-0000-4000-8000-000000000002", "day_of_week": 1, "effective_language": "en", "enabled": true, "format": "pdf", "id": "00000000-0000-4000-8000-000000000001", "language": "en", "name": "Weekly summary", "next_run_at": "2026-11-02T00:55:00Z", "organization_id": "00000000-0000-4000-8000-000000000003", "params": { "preset": "7d" }, "recipients": [ "anna@example.com" ], "report_type": "summary", "send_hour": 9, "timezone": "Europe/Berlin", "updated_at": "2026-10-27T09:00:00Z" } }