Sign in
Reports

Update Report

Update an existing report. Requires admin authentication.

put/admin/reports/{report_id}

Path parameters

report_idstring required

Request body

namestring nullable

Report name

report_type'leads_summary' | 'inquiries_summary'

Report type enum for Pydantic schemas

frequency'daily' | 'weekly'

Report frequency enum for Pydantic schemas

send_timestring nullable

Time of day to send the report (HH:MM:SS)

emailsstring[] nullable

List of email addresses

user_idsstring[] nullable

List of user IDs to receive the report

staff_group_idsstring[] nullable

List of staff group IDs to receive the report

leads_summary_include_qualifiedboolean nullable

Include qualified leads in leads summary report

leads_summary_include_partially_qualifiedboolean nullable

Include partially qualified leads in leads summary report

leads_summary_include_no_matched_caseboolean nullable

Include no matched case leads in leads summary report

Response

Successful Response

idstring required

Report ID

namestring required

Report name

messagestring required

Success message

Changes

No recorded changes to this endpoint across all 1 revision of this API.