Email tax summaries (selected donors or admin recipients)
Generates and queues delivery of year-end tax summary letters via MailingGenerationService. The delivery mode is derived from inputs: email_selected_donors when send_to_selected_donors=true, email_explicit when an explicit recipients list is supplied, otherwise email_admin (the calling admin gets the summary). donor_ids accepts an array of integer ids OR the literal string all; when all is combined with send_to_selected_donors=true, hysform_id becomes required. Returns 200 once the generation is queued. Requires permission: mailings_generate (also satisfied by mailings_manage or manage_email).
Authorizations
Passport bearer token authentication for legacy admin sessions.
Body
Array of donor IDs to summarize, or the literal string all.
Tax year the summary covers.
2025
Optional household scope for a consolidated household tax summary.
101
When true, emails the donors directly instead of the admin. Defaults to false.
true
Donor form to scope donor_ids=all to. Required when donor_ids=all and send_to_selected_donors=true. May also be the literal string all.
42
Explicit list of email recipients (used when send_to_selected_donors=false). Empty entries are stripped.