Template Operations

Clone global template

Changed on

<small>Requires an API token with the Template Manager role.</small>

Clones a global template into your account. The cloned template will be published by default so that you can immediately create documents from it using the create document from template endpoint.

The terms_confirmed field must be set to true to acknowledge that you have read and accepted the terms associated with the global template (such as author attribution and licensing requirements).

post/global-templates/clone

Request

  • Base URL
    https://app.fynk.com/v1/api
  • URL
    https://app.fynk.com/v1/api/global-templates/clone
  • Auth
    HTTP bearer

Request body

global_template_uuidstring uuid required

UUID of the global template to clone into your account

namestring nullable

Optional name for the cloned template. If omitted, the name of the global template will be used

team_uuidsstring[] nullable

UUIDs of the teams to assign to the cloned template

publishedboolean nullable

Whether to publish the cloned template immediately. Defaults to true

terms_confirmedboolean required

Must be true to confirm acceptance of the global template's terms (author attribution, licensing)

Example request

{
  "name": "Employment Contract",
  "published": true
}

Response

TemplateMinimalResource

Example response

{
  "data": {
    "uuid": "4df1e60a-0114-4dce-89e7-8c5ad397fcf2",
    "name": "Employment Contract",
    "locale": "de-AT",
    "parties": [
      {
        "uuid": "595703a2-b7f6-4772-a4b7-ab2f9fac3a9f",
        "ref_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "reference": "Employer",
        "entity_name": "Demo Inc.",
        "address": "1 Oxford Road\nHenley Bridge\nHB1 1PQ"
      }
    ],
    "links": {
      "show": "https:..."
    }
  }
}

Changes

    • warning

      added the new aes_eid enum value to the // response property for the response status

    • info

      added the optional property to the response with the status