FIfirma
Templates

Add a document to a template

Changed on

Adds a document (a temporary upload from POST /documents) to the template's document set, at position or last. Documents at that position and after it move up by one. At most 20 documents and 100 MB per template.

Available to every company. This operation is part of the multi-document contract (API 01.39.00). For a signing request or template the API key cannot see, it answers 404 with code NOT_FOUND ("Endpoint not found"), exactly as an unknown endpoint does. While multi-document editing is suspended, this operation returns 409 MULTI_DOCUMENT_READ_ONLY for parents on the multi-document read-only path and 404 NOT_FOUND for parents on the single-document path.

post/templates/{id}/documents

Request

Path parameters

idstring uuid required

Template ID

Request body

document_idstring uuid required

Temporary upload id from POST /documents (a PDF). Consumed once the document is added.

positioninteger

1-based position of the new document; at most the current count + 1. Defaults to last.

labelstring nullable

Display name of the document (no control characters).

original_filenamestring nullable

File name to record for the document (no control characters).

Response

Document added; the full document set after the change

documents_versioninteger required
documents_layout_versioninteger required

Example response

{
  "documents": [
    {
      "document_id": null,
      "position": 1,
      "label": null,
      "original_filename": null,
      "page_count": 3,
      "document_url": "https://api.firma.dev/storage/v1/object/sign/signing-request-documents/example.pdf?token=example",
      "document_url_kind": "stored",
      "document_only_hash": null
    }
  ]
}

Changes

  • a6525941bc28Revision changes
    • breaking

      added to the response body oneOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

  • bfc2b19c9c7eRevision changes
    • info

      endpoint added