Queue a composer email, one message per recipient, for sending through the configured SMTP server
POST/email/send
Recipients are given as person and family ids, never as addresses: the server resolves each id to its current email address, applies the do-not-email property, skips deceased people, inactive families and ids without an address, deduplicates addresses, and reports every skipped recipient by name. Each recipient receives their own message. Nothing is sent inside this request: every message is queued (email history status queued) under one batch id and the call returns at once. POST /email/batches/{batch}/send sends the batch now in bounded steps; whatever is left goes out with the timer jobs (cron, or the page-load fallback). sent and failed are always empty here and are kept for older clients; follow the batch for outcomes.
Request​
Responses​
- 200
- 400
- 401
- 403
- 422
Per-recipient outcome of the queueing
Invalid request: raw addresses, no ids, bad ids, more than 500 ids, or empty subject/body
Unauthorized
Email permission required
Email sending is disabled or SMTP is not configured
Can't find what you need? Ask in Discord, or open an issue on the ChurchCRM repository.