Skip to content

Update one email template

PATCH/account/emails/{kind}

Costs 2 rate-limit points · Rate limits

Set the store's own subject and/or body for one email kind: invoice, quote, credit_note or payment_reminder. Liquid placeholders are allowed and checked. Sending the default text (or an empty string) returns that field to the default for the language. The text is only sent when custom_text is true (PATCH /account/emails); each template says in_use. Returns the emails section.

Used for every email of that kind from now on, as long as custom text is on (custom_text in PATCH /account/emails).

Also searched aschange the invoice email textedit email subjectedit the payment reminder emailcustomise the quote emailreset the email body to defaultset credit note email wording

Path parameters

  • kindstringRequired

    invoice, quote, credit_note or payment_reminder.

Request body

  • subjectstring

    The email subject; Liquid placeholders such as {{order_number}} are allowed.

  • bodystring

    The email body; Liquid placeholders are allowed.

Returns

  • localestring
    Example: en
  • custom_textboolean
    Example: false
  • templatesobject
    Show 4 child attributesHide child attributes
    • invoiceobject
      Show 4 child attributesHide child attributes
      • subjectstring
        Example: Invoice {{invoice_number}}
      • bodystring
        Example: Thanks!
      • 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
  • noticestring
    Example: Saved, but not used yet: emails send the default text unt…

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.

404

The resource does not exist for this shop, or no action is registered at this path.

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/{kind}
curl -X PATCH "https://app.invoicefalcon.com/api/v3/external/account/emails/{kind}" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": "Your invoice {{invoice_number}} from {{shop_name}}"
  }'
Response
{
  "locale": "en",
  "custom_text": false,
  "templates": {
    "invoice": {
      "subject": "Invoice {{invoice_number}}",
      "body": "Thanks!",
      "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
    }
  },
  "notice": "Saved, but not used yet: emails send the default text until custom_text is true (PATCH /account/emails {\"custom_text\": true})."
}