Update email settings
/account/emailsCosts 2 rate-limit points · Rate limits
Change the language emails go out in and whether the store's own email text is used instead of the default. Deep partial. To change the text itself use PATCH /account/emails/:kind. Returns the emails section as the read shows it.
Applies to every email sent from now on. Custom email text needs a paid plan.
Also searched aschange email languagesend emails in germanuse my own email textturn off custom email textemail localeswitch to default email text
Request body
localestringLanguage of the default email texts (and of the subject/body placeholders).
One ofazbgcsdadeeleneses-MXetfifritjakoltlvnlnnplptroskslsvzhcustom_textbooleanUse the store's own subject and body (see PATCH /account/emails/:kind) instead of the default text for the language.
Returns
localestringExample:decustom_textbooleanExample:truetemplatesobjectShow 4 child attributesHide child attributes
invoiceobjectShow 4 child attributesHide child attributes
subjectstringExample:{{shop_name}} - Ihre Rechnung zur Bestellung Nr. {{order_…bodystringExample:Hallo, vielen Dank für Ihren Einkauf bei {{shop_name}}. …customizedbooleanExample:falsein_usebooleanExample:false
quoteobjectShow 4 child attributesHide child attributes
subjectstringExample:{{shop_name}} - Ihr Angebot {{order_number}}bodystringExample:Hallo, danke für die Kontaktaufnahme {{shop_name}}. Wie g…customizedbooleanExample:falsein_usebooleanExample:false
credit_noteobjectShow 4 child attributesHide child attributes
subjectstringExample:{{shop_name}} - Gutschrift {{order_number}}bodystringExample:Hallo, an dieser E-Mail finden Sie die Gutschrift für Ihr…customizedbooleanExample:falsein_usebooleanExample:false
payment_reminderobjectShow 4 child attributesHide child attributes
subjectstringExample:{{shop_name}} - Erinnerung an Ihre Rechnung Nr. {{order_n…bodystringExample:Hallo, danke für den Einkauf bei {{shop_name}}. Dies ist …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 -X PATCH "https://app.invoicefalcon.com/api/v3/external/account/emails" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"locale": "de",
"custom_text": true
}'const res = await fetch("https://app.invoicefalcon.com/api/v3/external/account/emails", {
method: "PATCH",
headers: {
"X-Auth-Token": process.env.INVOICE_FALCON_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"locale": "de",
"custom_text": true
}),
});
const data = await res.json();import os
import requests
res = requests.patch(
"https://app.invoicefalcon.com/api/v3/external/account/emails",
headers={"X-Auth-Token": os.environ["INVOICE_FALCON_API_KEY"]},
json={
"locale": "de",
"custom_text": True
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.invoicefalcon.com/api/v3/external/account/emails")
req = Net::HTTP::Patch.new(uri, "X-Auth-Token" => ENV["INVOICE_FALCON_API_KEY"], "Content-Type" => "application/json")
req.body = {
locale: "de",
custom_text: true
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"locale": "de",
"custom_text": true,
"templates": {
"invoice": {
"subject": "{{shop_name}} - Ihre Rechnung zur Bestellung Nr. {{order_number}}",
"body": "Hallo,\n\nvielen Dank für Ihren Einkauf bei {{shop_name}}. Im Anhang finden Sie die Rechnung für Ihre Bestellung {{order_number}}.\n\nMit freundlichen Grüßen\n\ndas Team von {{shop_name}}",
"customized": false,
"in_use": false
},
"quote": {
"subject": "{{shop_name}} - Ihr Angebot {{order_number}}",
"body": "Hallo, danke für die Kontaktaufnahme {{shop_name}}. Wie gewünscht habe ich Ihr Angebot an diese E-Mail angehängt. Bitte werfen Sie einen Blick darauf und teilen Sie mir mit, wie Sie fortfahren möchten.\n\nMit freundlichen Grüßen\n\ndas Team von {{shop_name}}",
"customized": false,
"in_use": false
},
"credit_note": {
"subject": "{{shop_name}} - Gutschrift {{order_number}}",
"body": "Hallo, an dieser E-Mail finden Sie die Gutschrift für Ihre Bestellung.\n\nMit freundlichen Grüßen\n\ndas Team von {{shop_name}}",
"customized": false,
"in_use": false
},
"payment_reminder": {
"subject": "{{shop_name}} - Erinnerung an Ihre Rechnung Nr. {{order_number}}",
"body": "Hallo,\ndanke für den Einkauf bei {{shop_name}}. Dies ist eine sanfte Erinnerung daran, dass Ihre Rechnung überfällig ist.\n\nWenn Sie diese Rechnung bereits bezahlt haben, ignorieren Sie diese Nachricht bitte.\n\nBeste,\nDas {{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"
}