Skip to main content
POST
Email year-end statements to households

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Body

application/json
emailset_id
integer
required

Email set / template to use. Validation: required.

Example:

88

household_ids
integer[]
required

Households to email. When empty, the handler returns 200 with an error_message instead of 400.

Example:
year
integer
required

Tax year covered by the statement.

Example:

2025

Response

Statements queued (or error_message set when household_ids was empty).

success_message
string
Example:

"2025 Year End Statements successfully sent to 5 Households."

error_message
string
Example:

"Household ids required"