Factuarea APIDevelopers
Support
Open app

Archive a PDF template

Archive a template and resolve every association that depends on it in one atomic step.

  • First read the impact of the template with action=archive, then send its expected_impact_fingerprint, the expected_version of the template and one decision per listed association in replacements (replace, clear or pause).
  • A changed impact returns 409 pdf_library_impact_conflict and nothing is modified.
  • Archived templates keep their revisions and the documents that already used them.
  • Requires pdf_templates:write and supports Idempotency-Key.
POST
/companies/{company}/pdf-templates/{template}/archive

Authorization

AuthorizationBearer <token>

Your API key as a bearer token: fact_live_… in production, fact_test_… in sandbox. See the authentication guide.

In: header

Path Parameters

company*string

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Formatuuid
template*string

Public identifier (UUID v7) of the PDF template.

Formatuuid

Headers

Idempotency-Key?string

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 422 idempotency_key_reused; the values of secret fields (password, secret…) count as part of the body, so retrying with a corrected secret under the same key is a different request, never the replay of the earlier answer. See the Idempotency guide.

Length1 <= length <= 255
Factuarea-Version?string

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Formatdate

Request Body

application/json

Internal reversible write: idempotency follows the current policy; a supplied key is replayed before CAS. Unknown fields are rejected. Until the company is prepared for revisioned templates (tenant initialization pending or revisioned rendering off) every library write returns 422 pdf_presentation_not_ready before any precondition or effect; reads stay available and no Retry-After applies.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

Previous/v1/companies/{company}/pdf-commercial-identities/{identity}/archive
POST

Archive a PDF commercial identity

Archive a brand identity and resolve in the same atomic step every template or default that points to it. Send the expected_impact_fingerprint read from the impact endpoint, the expected_version and one decision per association in replacements (replace, clear or pause; a template link also accepts revision_id). A changed impact returns 409 and nothing is modified. Retained images are not deleted. Requires pdf_templates:write and supports Idempotency-Key.

Next/v1/companies/{company}/pdf-commercial-identities
POST

Create a PDF commercial identity

Create a brand identity with its first revision: name plus a configuration with the commercial name, logo and brand image asset identifiers, brand mode and contact email, phone and address. Assets must belong to your company and be of the right kind. Supply id and revision_id (UUID v7) to choose the identifiers yourself. Returns 201. Only company administrators can create it. Requires pdf_templates:write and supports Idempotency-Key.