Skip to main content
PUT
Update an AI report schedule

Yetkilendirmeler

Authorization
string
header
gerekli

The access token received from the authorization server in the OAuth 2.0 flow.

Başlıklar

X-Tenant
number
gerekli

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Yol Parametreleri

id
integer
gerekli

The AI report schedule identifier

Gövde

application/json
name
string

The name of the AI report schedule.

Maximum string length: 120
systems
enum<string>[]

The modules included in scheduled reports.

Minimum array length: 1

The report module.

Mevcut seçenekler:
appointment,
treatment,
room,
customer,
demographics,
customer_form,
revenue,
collections,
sale_items,
installments,
payment_methods,
lead,
pipeline,
offer,
lead_source,
chat,
channel,
blacklist,
ai_suggestion,
ticket,
low_stock,
stock_movement,
staff,
doctor_workload,
storage,
credits,
all
period_label
enum<string>

The report period.

Mevcut seçenekler:
today,
yesterday,
last_7_days,
last_30_days,
this_week,
this_month,
last_month,
this_year,
custom_date_range
period_start_date
string<date-time> | null

The custom period start date.

period_end_date
string<date-time> | null

The custom period end date.

frequency
enum<string>

The schedule frequency.

Mevcut seçenekler:
daily,
weekly,
monthly
time
string | null

The fixed run time in a half-hour slot.

Pattern: ^(?:[01]\d|2[0-3]):(?:00|30)$
timezone
string

The IANA timezone used by the schedule.

follows_work_hours
boolean

Whether the schedule follows clinic closing time.

starts_at
string<date-time> | null

The calendar date when recurrence starts.

is_active
boolean

Whether the AI report schedule is active.

Yanıt

success
string
gerekli
data
AIReportScheduleResource · object
gerekli