pub struct BulkletterCreate {
pub content: String,
pub group_by_household: bool,
pub group_id: Option<Option<i64>>,
pub html_template_id: i64,
pub name: String,
pub person_ids: Vec<i64>,
pub extra: Map<String, Value>,
}Expand description
Creates a mail-merge job using an HTML template and selected person IDs. Requires edit bulkletter permission and visibility of the template. Successful creation only schedules rendering.
Fields§
§content: StringHTML inserted into the template’s {{content}} slot. Supports person/group placeholders. Non-empty; the literal string 0 is rejected.
group_by_household: boolGroup persons by identical street, address addition, postal code, city and country. Only persons with street, postal code and city are grouped. The first person returned for each address represents it; this is not a family-relationship or household-head calculation.
group_id: Option<Option<i64>>Optional group used as placeholder context, not as a restriction on personIds.
None leaves the field out, Some(None) sends null.
html_template_id: i64ID of the HTML template used to render the bulkletter.
name: StringJob name. Non-empty; the literal string 0 is rejected by the current validator.
person_ids: Vec<i64>Person IDs to render. Duplicate IDs are resolved through the person lookup; unknown IDs do not create recipient rows.
extra: Map<String, Value>Fields not described by the spec, e.g. instance-specific DB fields.