Skip to main content
POST
Create schedule report

Authorizations

Authorization
string
header
required

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

Body

application/json
report_type
enum<string>
required
Available options:
bill_pay_donations_dfa,
invoicing,
cogs,
partner_summary_total,
partner_members,
younegotiate_revenue,
compliance_consumer_pii_opt_out,
compliance_consumer_disputes_no_pay,
compliance_auto_expired_deleted_accounts,
consumer_payments,
super_admin_all_accounts
frequency
enum<string>
required
Available options:
daily,
weekly,
monthly
delivery_type
enum<string>
required
Available options:
email
emails
string
required

Comma-separated list of up to five valid email addresses.

Example:

"reports@example.com, ops@example.com"

company_id

Use all_members, omit the field, or pass a company ID from the options endpoint.

Available options:
all_members
Example:

"all_members"

Response

Schedule report created.

message
string
required
Example:

"Schedule report created."

data
object
required
Last modified on July 20, 2026