---
title: "Send invoice emails"
method: POST
path: "/v1/invoices/send-email"
tags: ["Invoices"]
---

# Send invoice emails

`POST /v1/invoices/send-email`

Send a specific email (`email_type`) to the customer for a list of invoices, asynchronously in batch. An invoice whose status doesn't resolve to the requested email is skipped. Results can be tracked via webhooks with the `invoice.batch.email_succeeded`, `invoice.batch.email_skipped` and `invoice.batch.email_failed` events.

## Request body

- object
  - `batch_id` string — Optional client-supplied identifier for the batch. Echoed back in the response and on the emitted webhook events. Generated if omitted.
  - `email_type` 'invoice_ready' | 'invoice_settled' | 'invoice_errored' | 'credit_note_settled', required — The email to send. The invoice's status must resolve to this email, otherwise it is skipped with reason `email_type_mismatch`. - `invoice_ready`: The to-pay invoice email (for `to_pay`, `partially_paid`, `late` invoices). - `invoice_settled`: The paid-invoice email (for `paid` invoices). - `invoice_errored`: The failed-payment email (for `error` invoices with a payment method). - `credit_note_settled`: The credit-note email (for paid refunds).
  - `ids` string[], required — IDs of the invoices to send the email for. Processed asynchronously; each outcome is reported via webhook events.

## Response `202`

- object
  - `batch_id` string, required — Identifier of the batch request. Use it to correlate the `invoice.batch.email_succeeded`, `invoice.batch.email_skipped` and `invoice.batch.email_failed` webhook events.

---

[API](https://skmtc.dev/hyperline/apis/hyperline-api.md) · [All operations](https://skmtc.dev/hyperline/apis/hyperline-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hyperline/hyperline-api/revisions/19fa5f22e39b/schema)