Skip to main content
PATCH
/
v2
/
report-configs
/
{report_config_id}
Update
curl --request PATCH \
  --url https://api.example.com/v2/report-configs/{report_config_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "time": "<string>",
  "weekday": 3,
  "recipient_emails": [
    "<string>"
  ],
  "cc_emails": [
    "<string>"
  ],
  "is_enabled": true
}
'
{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "is_enabled": true,
  "time": "<string>",
  "weekday": 123,
  "recipient_emails": [
    "<string>"
  ],
  "cc_emails": [
    "<string>"
  ],
  "last_sent_at": "2023-11-07T05:31:56Z",
  "object": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.api.stuut.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
report_config_id
string
required

Body

application/json

Request body for updating a report config.

​
frequency
enum<string> | null
Available options:
daily,
weekly,
monthly
​
time
string<time> | null
​
weekday
integer | null
Required range: 0 <= x <= 6
​
recipient_emails
string[] | null
​
cc_emails
string[] | null
​
is_enabled
boolean | null

Response

Successful Response

Report configuration response.

​
created_at
string<date-time>
required
​
modified_at
string<date-time> | null
required
​
id
string
required
​
report_type
enum<string>
required

Discriminator for report type

Available options:
integration_sync_report,
ar_aging_report
​
is_enabled
boolean
required
​
frequency
enum<string>
required

How often to send the report (DAILY, WEEKLY, MONTHLY)

Available options:
daily,
weekly,
monthly
​
time
string<time>
required

Time of day (HH:MM) in org timezone. Minutes must be 0 or 30.

​
weekday
integer
required

Day of the week (0=Monday, 6=Sunday). Only used by WEEKLY frequency.

​
recipient_emails
string[]
required

Primary recipient email addresses

​
cc_emails
string[] | null
required

Optional CC email addresses (e.g., FDE team on failures)

​
last_sent_at
string<date-time> | null
required

UTC timestamp of the last successful report send

​
object
string
required
read-only

String representing the object's type. Objects of the same type share the same value.