Skip to content

Update email settings

PATCH/account/emails

Costs 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

  • localestring

    Language of the default email texts (and of the subject/body placeholders).

    One of azbgcsdadeeleneses-MXetfifritjakoltlvnlnnplptroskslsvzh
  • custom_textboolean

    Use the store's own subject and body (see PATCH /account/emails/:kind) instead of the default text for the language.

Returns

  • localestring
    Example: de
  • custom_textboolean
    Example: true
  • templatesobject
    Show 4 child attributesHide child attributes
    • invoiceobject
      Show 4 child attributesHide child attributes
      • subjectstring
        Example: {{shop_name}} - Ihre Rechnung zur Bestellung Nr. {{order_…
      • bodystring
        Example: Hallo, vielen Dank für Ihren Einkauf bei {{shop_name}}. …
      • customizedboolean
        Example: false
      • in_useboolean
        Example: false
    • quoteobject
      Show 4 child attributesHide child attributes
      • subjectstring
        Example: {{shop_name}} - Ihr Angebot {{order_number}}
      • bodystring
        Example: Hallo, danke für die Kontaktaufnahme {{shop_name}}. Wie g…
      • customizedboolean
        Example: false
      • in_useboolean
        Example: false
    • credit_noteobject
      Show 4 child attributesHide child attributes
      • subjectstring
        Example: {{shop_name}} - Gutschrift {{order_number}}
      • bodystring
        Example: Hallo, an dieser E-Mail finden Sie die Gutschrift für Ihr…
      • customizedboolean
        Example: false
      • in_useboolean
        Example: false
    • payment_reminderobject
      Show 4 child attributesHide child attributes
      • subjectstring
        Example: {{shop_name}} - Erinnerung an Ihre Rechnung Nr. {{order_n…
      • bodystring
        Example: Hallo, danke für den Einkauf bei {{shop_name}}. Dies ist …
      • customizedboolean
        Example: false
      • in_useboolean
        Example: false

Errors

401

Missing or unknown X-Auth-Token, or the shop uninstalled the app.

403

v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.

422

The request failed validation. Nothing was saved.

429

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.

PATCH/account/emails
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
  }'
Response
{
  "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
    }
  }
}