Skip to content

Delete template

DELETE/templates/{id}

Costs 2 rate-limit points · Rate limits

Delete a template. A template that is the default for any order kind is refused: make another template the default first. Existing PDFs are kept.

Cannot be undone. Documents already generated keep their PDF. Send it first without confirm: nothing changes and the 409 confirmation_required says what would. Tell the merchant, ask, and resend with confirm: true (?confirm=true on a DELETE) only after they agree.

Also searched asdelete templateremove a templateget rid of the old invoice template

Path parameters

  • idstringRequired

    Template id.

Query parameters

  • confirmboolean

    Send true only after the merchant agreed. Without it nothing is deleted and the 409 says what would be.

Returns

  • idinteger
    Example: 170
  • deletedboolean
    Example: true

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.

409

The request conflicts with the current state (an issued invoice is locked, the next invoice number moved, a template is still in use, a job already finished). Nothing was changed.

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.

DELETE/templates/{id}
curl -X DELETE "https://app.invoicefalcon.com/api/v3/external/templates/125" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
Response
{
  "id": 170,
  "deleted": true
}