Send Invoice Reminder
POST /api/v1/invoices/{id}/send_reminder
Send a custom reminder email for an overdue or pending invoice. Similar to sending an invoice but focused on payment reminders.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
integer | Yes | The unique ID of the invoice. |
Request Body
Same as Send Invoice, but uses send_reminder_form prefix. Default subject: “Payment Reminder for Invoice #{number}”.
Request Example
{ "send_reminder_form": { "recipient": "procurement@texas.com", "copy": "given@flixtechs.co.zw", "subject": "Invoice #INV-BA1F-1656 from Flixtechs", "content": "<div>Hi {{ invoice.customer.name }}, <br><br>A friendly reminder that your invoice #{{ invoice.number }} is due. <br><br>{%- button url: invoice.pay_url -%}Pay Now{%- endbutton -%}<br><br></div>" } }
POST /api/v1/invoices/123/send_reminder HTTP/1.1
Host: koteshen.com
Authorization: Bearer {access_token}
Content-Type: application/json
Accept: application/json
{request_body}
Response
Status Codes:
200 OK- Reminder sent.401 Unauthorized- Invalid or missing token.404 Not Found- Invoice not found.422 Unprocessable Entity- Invalid email or templating errors.
Success Response (200)
{ "message": "Reminder sent to procurement@texas.com", "invoice_id": 123, "sent_at": "2025-10-21T00:00:00.000Z" }