Skip to content

Retrieve email settings

GET/account/emails

Costs 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

  • localestring
    Example: en
  • custom_textboolean
    Example: false
  • templatesobject
    Show 4 child attributesHide child attributes
    • invoiceobject
      Show 4 child attributesHide child attributes
      • subjectstring
        Example: Your invoice {{order_number}}
      • bodystring
        Example: Hi
      • customizedboolean
        Example: true
      • in_useboolean
        Example: false
    • quoteobject
      Show 4 child attributesHide child attributes
      • subjectstring
        Example: {{shop_name}} - Quote for your Order {{order_number}}
      • bodystring
        Example: Hello, Thank you for shopping at {{shop_name}}. We have …
      • customizedboolean
        Example: false
      • in_useboolean
        Example: false
    • credit_noteobject
      Show 4 child attributesHide child attributes
      • subjectstring
        Example: {{shop_name}} - Credit Note {{order_number}}
      • bodystring
        Example: Hello, Please find attached the credit note for your ord…
      • customizedboolean
        Example: false
      • in_useboolean
        Example: false
    • payment_reminderobject
      Show 4 child attributesHide child attributes
      • subjectstring
        Example: {{shop_name}} - Reminder for your Invoice {{order_number}}
      • bodystring
        Example: Hello, Thank you for shopping at {{shop_name}}. This is …
      • 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.

GET/account/emails
curl "https://app.invoicefalcon.com/api/v3/external/account/emails" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
Response
{
  "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
    }
  }
}