Retrieve email settings
/account/emailsCosts 1 rate-limit point · Rate limits
The email language and, for each document type (invoice, quote, credit note, payment reminder), the subject and body the store sends, with customized telling whether that is the merchant's own text or the default for the language. Read-only.
Also searched asemail templateswhat does my invoice email sayemail subject and bodyemail languagecustom email textpayment reminder email text
Returns
localestringExample:encustom_textbooleanExample:falsetemplatesobjectShow 4 child attributesHide child attributes
invoiceobjectShow 4 child attributesHide child attributes
subjectstringExample:Your invoice {{order_number}}bodystringExample:HicustomizedbooleanExample:truein_usebooleanExample:false
quoteobjectShow 4 child attributesHide child attributes
subjectstringExample:{{shop_name}} - Quote for your Order {{order_number}}bodystringExample:Hello, Thank you for shopping at {{shop_name}}. We have …customizedbooleanExample:falsein_usebooleanExample:false
credit_noteobjectShow 4 child attributesHide child attributes
subjectstringExample:{{shop_name}} - Credit Note {{order_number}}bodystringExample:Hello, Please find attached the credit note for your ord…customizedbooleanExample:falsein_usebooleanExample:false
payment_reminderobjectShow 4 child attributesHide child attributes
subjectstringExample:{{shop_name}} - Reminder for your Invoice {{order_number}}bodystringExample:Hello, Thank you for shopping at {{shop_name}}. This is …customizedbooleanExample:falsein_usebooleanExample:false
Errors
Missing or unknown X-Auth-Token, or the shop uninstalled the app.
v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.
The request failed validation. Nothing was saved.
Rate limited: cost-weighted per key (reads cost less than writes). Wait Retry-After seconds; see X-RateLimit-* headers.
Every error has the same shape: see Errors.
curl "https://app.invoicefalcon.com/api/v3/external/account/emails" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY"const res = await fetch("https://app.invoicefalcon.com/api/v3/external/account/emails", {
headers: {
"X-Auth-Token": process.env.INVOICE_FALCON_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.invoicefalcon.com/api/v3/external/account/emails",
headers={"X-Auth-Token": os.environ["INVOICE_FALCON_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.invoicefalcon.com/api/v3/external/account/emails")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["INVOICE_FALCON_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"locale": "en",
"custom_text": false,
"templates": {
"invoice": {
"subject": "Your invoice {{order_number}}",
"body": "Hi",
"customized": true,
"in_use": false
},
"quote": {
"subject": "{{shop_name}} - Quote for your Order {{order_number}}",
"body": "Hello,\n\nThank you for shopping at {{shop_name}}. We have attached the Quote for your Order {{order_number}} to this email.\n\nRegards,\nThe {{shop_name}} Team",
"customized": false,
"in_use": false
},
"credit_note": {
"subject": "{{shop_name}} - Credit Note {{order_number}}",
"body": "Hello,\n\nPlease find attached the credit note for your order to this email.\n\nRegards,\nThe {{shop_name}} Team",
"customized": false,
"in_use": false
},
"payment_reminder": {
"subject": "{{shop_name}} - Reminder for your Invoice {{order_number}}",
"body": "Hello,\n\nThank you for shopping at {{shop_name}}. This is a gentle reminder that your invoice {{invoice_number}} is past due.\n\nIf you have already paid this invoice, please disregard this message.\n\nBest,\nThe {{shop_name}} Team",
"customized": false,
"in_use": false
}
}
}{
"errors": [
"Invalid API key"
],
"code": "unauthorized"
}{
"errors": [
"API access requires a paid plan"
],
"code": "paid_plan_required"
}{
"errors": [
"id is missing"
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited"
}