Template Operations

Clone global template

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

POST

/global-templates/clone

curl --request POST \
  --url https://app.fynk.com/v1/api/global-templates/clone \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "global_template_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Employment Contract",
  "published": true,
  "team_uuids": [
    "<string>"
  ],
  "terms_confirmed": true
}
'

{
  "data": {
    "archived_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "links": {
      "show": "https:..."
    },
    "locale": "de-AT",
    "name": "Employment Contract",
    "parties": [
      {
        "address": "1 Oxford Road\nHenley Bridge\nHB1 1PQ",
        "created_at": "2023-11-07T05:31:56Z",
        "entity_name": "Demo Inc.",
        "is_internal_party": true,
        "ref_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "reference": "Employer",
        "scope": "internal",
        "updated_at": "2023-11-07T05:31:56Z",
        "uuid": "595703a2-b7f6-4772-a4b7-ab2f9fac3a9f"
      }
    ],
    "published": true,
    "sequential_signing": true,
    "signature_type": "aes",
    "updated_at": "2023-11-07T05:31:56Z",
    "uuid": "4df1e60a-0114-4dce-89e7-8c5ad397fcf2"
  }
}

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).

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

global_template_uuidstringrequired

UUID of the global template to clone into your account

namestring | null

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

Maximum string length: 255

Example: Employment Contract

publishedboolean | null

Whether to publish the cloned template immediately. Defaults to true

Example: true

team_uuidsstring[] | null

UUIDs of the teams to assign to the cloned template

terms_confirmedbooleanrequired

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

Response

TemplateMinimalResource

dataobjectrequired

Show child attributes

Still need help? Share an idea