Send invoice email
POST
/invoices/{slug}/send_emailCosts 2 rate-limit points · Rate limits
Send (or resend) the invoice email to the customer. Optionally specify a template for the PDF attachment.
Path parameters
slugstringRequiredThe invoice's unique slug (UUID).
Request body
template_idintegerOptional template ID for the PDF attachment.
Returns
messagestringExample:Email queued for delivery
Errors
401
Missing or invalid API key.
403
The store is not on a paid plan. API access requires a paid Invoice Falcon plan.
404
Resource not found.
422
Request could not be processed.
429
Rate limit exceeded. Check X-RateLimit-Reset header.
POST/invoices/{slug}/send_email
curl -X POST "https://app.invoicefalcon.com/api/v1/external/invoices/{slug}/send_email" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"message": "Email queued for delivery"
}'const res = await fetch("https://app.invoicefalcon.com/api/v1/external/invoices/{slug}/send_email", {
method: "POST",
headers: {
"X-Auth-Token": process.env.INVOICE_FALCON_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"message": "Email queued for delivery"
}),
});
const data = await res.json();import os
import requests
res = requests.post(
"https://app.invoicefalcon.com/api/v1/external/invoices/{slug}/send_email",
headers={"X-Auth-Token": os.environ["INVOICE_FALCON_API_KEY"]},
json={
"message": "Email queued for delivery"
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.invoicefalcon.com/api/v1/external/invoices/{slug}/send_email")
req = Net::HTTP::Post.new(uri, "X-Auth-Token" => ENV["INVOICE_FALCON_API_KEY"], "Content-Type" => "application/json")
req.body = {
message: "Email queued for delivery"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)Response
{
"message": "Email queued for delivery"
}{
"error": "Invalid API key"
}{
"error": "REST API access requires a paid plan"
}{
"error": "Not found"
}{
"error": "param is missing or the value is empty: customer",
"errors": {}
}{
"error": "Rate limit exceeded",
"retry_after": 30,
"message": "You have exceeded the rate limit of 40 points per 60 seconds. Read requests cost 1 point(s) and write requests cost 2 point(s). Please retry after 30 second(s)."
}