Skip to content

Update report schedule​

PATCH
/report-schedules/{reportScheduleId}

Update a report schedule's parameters

Authorizations​

bearerAuth

Generate an API token here

Type
HTTP (bearer)

Parameters​

Header Parameters

compatibility-date*

API compatibility date in YYYY-MM-DD format. Must be a date after 2025-11-01.

Type
string
Required
Example"2025-11-01"
Pattern
"^\\d{4}-\\d{2}-\\d{2}$"
organization-id*
Type
string
Required
Min Length
1
Max Length
40

Path Parameters

reportScheduleId*
Type
string
Required

Request Body​

application/json
object
One of
object
Defaultfalse
object
Default0
Minimum0
Maximum59
Default0
Minimum0
Maximum23
object
Defaultfalse
object
Default0
Minimum0
Maximum59
Default0
Minimum0
Maximum23
Minimum1
Maximum7
object
Defaultfalse
object
Default0
Minimum0
Maximum59
Default0
Minimum0
Maximum23
Minimum1
Maximum31

Responses​

success.report-schedule.update

application/json
object
object
Required

Playground​

Authorization
Headers
Variables
Key
Value
Body

Samples​