fynk icon

fynk

Interact with the fynk API

Document → Create From Template

AI-generated

Summary

Create a new fynk document from a specified template by providing required dynamic field values, party details, and signatory information.

Inputs

  • Template (required) — Select the template to use for document creation either from a searchable list or by specifying its UUID.
  • Dynamic Field Values — Specify values for the template's dynamic fields, formatted according to their types (e.g., currency as "EUR;1232.00", duration as ISO 8601). Validation is performed on these values.
  • Parties — Provide details of parties involved by referencing party IDs from the template, including entity name and address.
  • Signatories — Add signatory information, including required email, optional first and last names, mobile phone, associated party reference, and title.
  • Additional Fields — Optionally set the new document's name (defaults to template name), initial stage (draft or signing), and owner email addresses.

Output shape

a list containing a single JSON object representing the created document.

The operation returns the API response of the newly created document as a JSON object in an array. Errors during dynamic field validation or API calls are returned as errors per item if 'continueOnFail' is enabled.

Examples

Example 1: Create a document from a known template UUID, filling in required dynamic fields, parties, and signatories, then setting the document state to 'signing' and assigning owners by email.

Template set by UUID; dynamicFieldValues with validated values; parties referenced by partyRefUuid with optional entity name and address; signatories with required emails; additionalFields including 'initial_stage' and 'owner_emails'.

Links

Discussion