Skip to content

Update template

PATCH/templates/{id}

Costs 2 rate-limit points · Rate limits

Change a template: its name, which order kinds it is the default for, logo, style, numbering, any editor section switch or text (sections.<group>.<field>, exactly as the read lists them), label overrides, content translations or the Liquid source. Deep partial. Returns the template in full.

Applies to every document generated from this template from now on; existing PDFs are unchanged. Setting a default_for kind clears it on the other templates. The Pay now link needs a paid plan.

Also searched asedit templateshow the sku on invoiceshide product images on the invoicerename templatechange the accent colourmake this the default invoice templateset the invoice prefix on a templateturn off the footer notes

Path parameters

  • idstringRequired

    Template id.

Request body

  • namestring

    Template name, unique in the store.

  • default_forobject
    Show 4 child attributesHide child attributes
    • ordersboolean

      Use this template for regular orders by default (clears it on the other templates).

    • draft_ordersboolean

      Default for draft orders / quotes.

    • pos_ordersboolean

      Default for POS orders.

    • credit_notesboolean

      Default for credit notes.

  • logoobject
    Show 4 child attributesHide child attributes
    • enabledboolean
    • urlstring, nullable

      Logo image URL; replaces an uploaded logo.

    • widthinteger, nullable

      Logo width in pixels.

    • lock_aspect_ratioboolean
  • styleobject
    Show 4 child attributesHide child attributes
    • accent_colorstring, nullable

      Hex colour, e.g. #1a1a1a.

    • font_familystring, nullable
    • font_sizeinteger, nullable
    • date_formatstring, nullable

      e.g. MMM DD, YYYY or DD/MM/YYYY.

  • numberingobject
    Show 4 child attributesHide child attributes
    • prefixstring, nullable

      Invoice number prefix for this template.

    • next_numberstring, nullable

      Next sequential number (digits). Applied as sent; read the template first.

    • use_order_numberboolean

      Number invoices after the Shopify order number.

    • credit_notes_use_order_numberboolean
  • sectionsobject
    Show 8 child attributesHide child attributes
    • order_informationobject
      Show 14 child attributesHide child attributes
      • show_invoice_numberboolean
      • show_custom_invoice_numberboolean
      • show_order_numberboolean
      • show_po_numberboolean
      • show_delivery_note_numberboolean
      • show_order_dateboolean
      • show_issue_dateboolean
      • show_due_dateboolean
      • show_fulfillment_dateboolean
      • show_payment_termsboolean
      • show_order_amountboolean
      • show_order_tagsboolean
      • show_barcodeboolean
      • show_order_barcodeboolean
    • payment_informationobject
      Show 10 child attributesHide child attributes
      • show_payment_addressboolean
      • show_payment_methodboolean
      • show_payment_breakdownboolean
      • show_credit_cardboolean
      • show_financial_statusboolean
      • show_discount_codeboolean
      • show_tax_dateboolean
      • show_tracking_companyboolean
      • show_tracking_numbersboolean
      • show_paid_by_customerboolean
    • shipping_informationobject
      Show 1 child attributeHide child attributes
      • show_shipping_addressboolean
    • customer_informationobject
      Show 5 child attributesHide child attributes
      • show_customer_emailboolean
      • show_customer_phoneboolean
      • show_customer_noteboolean
      • show_localized_tax_idboolean
      • localized_tax_id_stringstring, nullable
    • itemsobject
      Show 21 child attributesHide child attributes
      • show_product_imagesboolean
      • show_skuboolean
        Example: false
      • show_hs_codeboolean
      • show_product_weightboolean
      • show_total_product_weightboolean
      • show_country_of_originboolean
      • show_product_typeboolean
      • show_product_descriptionboolean
      • show_note_attributesboolean
      • show_variantsboolean
      • show_selling_planboolean
      • show_item_discountboolean
      • show_discount_reasonboolean
      • show_compare_at_priceboolean
      • show_original_priceboolean
      • show_propertiesboolean
      • show_item_barcodeboolean
      • show_total_qtyboolean
      • show_item_taxboolean
      • show_item_tax_amountboolean
      • group_amount_digitsboolean
    • order_totalobject
      Show 16 child attributesHide child attributes
      • show_subtotalboolean
      • show_order_discountboolean
      • show_order_discount_reasonboolean
      • show_discount_breakdownboolean
      • show_taxboolean
      • show_tax_inclusion_labelboolean
      • show_tax_breakdownboolean
      • show_shippingboolean
      • show_discountsboolean
      • show_shipping_rate_nameboolean
      • show_amount_in_wordsboolean
      • show_total_weightboolean
      • show_refund_amountboolean
      • show_refund_reasonboolean
      • show_payment_linkboolean
      • show_balanceboolean
    • extraobject
      Show 6 child attributesHide child attributes
      • show_order_notesboolean
      • show_footer_notesboolean
      • footer_messagestring, nullable
      • show_store_domainboolean
      • store_domain_textstring, nullable
      • show_paid_unpaid_watermarkboolean
    • socialobject
      Show 4 child attributesHide child attributes
      • show_social_pageboolean
      • facebook_urlstring, nullable
      • instagram_urlstring, nullable
      • twitter_urlstring, nullable
  • label_overridesobject

    Label text per field, e.g. { "invoice_number": "Rechnungsnummer" }.

  • content_translationsobject

    Text per field per language, e.g. { "footer_message": { "de": "Danke" } }. The only field is footer_message; languages are the store locale codes (de, fr, es...). Sent whole: it replaces the stored value, and blank entries are dropped, so {} clears every translation.

  • liquid_codestring

    The Liquid source of the template body.

Returns

The template object.

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/templates/{id}
curl -X PATCH "https://app.invoicefalcon.com/api/v3/external/templates/125" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Renamed",
    "sections": {
      "items": {
        "show_sku": false
      }
    },
    "numbering": {
      "prefix": "R-",
      "next_number": "501"
    },
    "style": {
      "accent_color": "#ff0000"
    }
  }'
Response
{
  "id": 175,
  "name": "Renamed",
  "document_type": "invoice",
  "design": {
    "key": "modern",
    "name": "Modern"
  },
  "default_for": {
    "orders": true,
    "draft_orders": false,
    "pos_orders": false,
    "credit_notes": false
  },
  "logo": {
    "enabled": true,
    "url": null,
    "width": 150,
    "lock_aspect_ratio": true
  },
  "created_at": "2026-11-10T09:07:44Z",
  "updated_at": "2026-11-10T09:07:44Z",
  "style": {
    "accent_color": "#ff0000",
    "font_family": "Arial",
    "font_size": 12,
    "date_format": "MMM DD, YYYY"
  },
  "numbering": {
    "prefix": "R-",
    "next_number": "501",
    "use_order_number": true,
    "credit_notes_use_order_number": false,
    "sequential_numbering_available": true
  },
  "sections": {
    "order_information": {
      "show_invoice_number": true,
      "show_custom_invoice_number": false,
      "show_order_number": true,
      "show_po_number": false,
      "show_delivery_note_number": false,
      "show_order_date": true,
      "show_issue_date": false,
      "show_due_date": false,
      "show_fulfillment_date": false,
      "show_payment_terms": false,
      "show_order_amount": true,
      "show_order_tags": false,
      "show_barcode": false,
      "show_order_barcode": false
    },
    "payment_information": {
      "show_payment_address": true,
      "show_payment_method": true,
      "show_payment_breakdown": false,
      "show_credit_card": true,
      "show_financial_status": false,
      "show_discount_code": false,
      "show_tax_date": false,
      "show_tracking_company": false,
      "show_tracking_numbers": false,
      "show_paid_by_customer": true
    },
    "shipping_information": {
      "show_shipping_address": true
    },
    "customer_information": {
      "show_customer_email": true,
      "show_customer_phone": true,
      "show_customer_note": true,
      "show_localized_tax_id": false,
      "localized_tax_id_string": "Tax ID"
    },
    "items": {
      "show_product_images": true,
      "show_sku": false,
      "show_hs_code": false,
      "show_product_weight": false,
      "show_total_product_weight": false,
      "show_country_of_origin": false,
      "show_product_type": false,
      "show_product_description": false,
      "show_note_attributes": false,
      "show_variants": true,
      "show_selling_plan": false,
      "show_item_discount": false,
      "show_discount_reason": false,
      "show_compare_at_price": false,
      "show_original_price": false,
      "show_properties": true,
      "show_item_barcode": false,
      "show_total_qty": false,
      "show_item_tax": true,
      "show_item_tax_amount": true,
      "group_amount_digits": false
    },
    "order_total": {
      "show_subtotal": true,
      "show_order_discount": true,
      "show_order_discount_reason": false,
      "show_discount_breakdown": false,
      "show_tax": true,
      "show_tax_inclusion_label": false,
      "show_tax_breakdown": true,
      "show_shipping": true,
      "show_discounts": true,
      "show_shipping_rate_name": true,
      "show_amount_in_words": false,
      "show_total_weight": false,
      "show_refund_amount": true,
      "show_refund_reason": false,
      "show_payment_link": false,
      "show_balance": true
    },
    "extra": {
      "show_order_notes": true,
      "show_footer_notes": false,
      "footer_message": null,
      "show_store_domain": false,
      "store_domain_text": null,
      "show_paid_unpaid_watermark": false
    },
    "social": {
      "show_social_page": false,
      "facebook_url": null,
      "instagram_url": null,
      "twitter_url": null
    }
  },
  "label_overrides": {},
  "content_translations": {},
  "liquid_code": "    <!DOCTYPE html>\n    <html>\n    <head>\n      <meta charset=\"utf-8\">\n      <link href=\"https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=Open+Sans:wght@400;600;700&family=No…"
}