v1

latestOpenAPI 3.1.02026-08-066378446.6 KB

Document Operations

Update document

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

Update a document's name, its signing settings and/or its document type.

put/documents/{document}

Path parameters

documentstring required

The document UUID

Request body

document_type_uuidstring uuid nullable

UUID of the document type to assign to the document. Pass null to remove the current document type. Use the List document types endpoint to discover the document type UUIDs available in your account

external_signatory_invitation_messagestring nullable

Optional text to display in the email notification sent to users when the document is ready for signing

namestring

Must be a non-empty string.

sequential_signingboolean

When true, signatories will sign in ascending order of their signing_order. Cannot be changed if signing has started

signature_type'aes' | 'qes' | 'ses'

Example request

{
  "document_type_uuid": "58ac52bb-8885-4580-88c1-7a7bc772c87d",
  "name": "Kundenvertrag Muster GmbH"
}

Response

DocumentDetailResource

Example response

{
  "data": {
    "uuid": "4df1e60a-0114-4dce-89e7-8c5ad397fcf2",
    "name": "Kundenvertrag Muster GmbH",
    "locale": "de-AT",
    "template_uuid": "4df1e60a-0114-4dce-89e7-8c5ad397fcf2",
    "document_type_uuid": "58ac52bb-8885-4580-88c1-7a7bc772c87d",
    "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"
      }
    ],
    "teams": [
      {
        "uuid": "281b685e-4b29-4618-8231-3822537b139d",
        "name": "HR"
      }
    ],
    "integration_reference": {
      "object_type": "Opportunity",
      "external_id": "000000000000Abc",
      "external_name": "Example Opportunity"
    },
    "users": [
      {
        "uuid": "76b8e0ad-e9cd-4c21-98b1-cd0003423ec2",
        "first_name": "Emily",
        "last_name": "Miller",
        "email": "miller@example.com",
        "title": "Sales Manager",
        "party_uuid": "595703a2-b7f6-4772-a4b7-ab2f9fac3a9f",
        "personal_link": {
          "uuid": "5cbe6ed1-49a9-40dc-a1c4-9e5a3c9a08f0",
          "url": "https:app.fynk.com/share/5cbe6ed1-49a9-40dc-a1c4-9e5a3c9a08f0?token=...",
          "expires_at": "2026-10-19T12:00:00Z",
          "message": "Hi Emily, please review the updated contract."
        }
      }
    ],
    "signatories": [
      {
        "uuid": "76b8e0ad-e9cd-4c21-98b1-cd0003423ec2",
        "first_name": "Emily",
        "last_name": "Miller",
        "email": "miller@example.com",
        "mobile_phone": "+447951123456",
        "title": "Sales Manager",
        "profile_photo_url": "https://ui-avatars.com/api/?name=EM",
        "party_uuid": "595703a2-b7f6-4772-a4b7-ab2f9fac3a9f"
      }
    ],
    "dynamic_fields": [
      {
        "uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc",
        "ref_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "name": "Gross salary",
        "settings": {
          "currencies": [
            "EUR",
            "USD"
          ]
        },
        "format": {
          "decimals": 2,
          "decimal_separator": ".",
          "thousands_separator": ","
        },
        "question": "What is the employee's gross salary in EUR?"
      }
    ],
    "metadata_values": [
      {
        "uuid": "4ed6c60b-bc4f-4390-bbf5-ed384e3443c9",
        "metadata": {
          "uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc",
          "name": "discount_rate",
          "display_name": "Discount Rate",
          "settings": {
            "currencies": [
              "EUR",
              "USD"
            ]
          },
          "description": "The discount rate applied to the company valuation in a follow-on financing round.",
          "keywords": "discount, rate, valuation",
          "prompt": "Extract the discount rate percentage from the document."
        },
        "reference_dynamic_field_uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc"
      }
    ],
    "tags": [
      {
        "uuid": "58ac52bb-8885-4580-88c1-7a7bc772c87d",
        "name": "Warranty",
        "color": "#615fff"
      }
    ]
  }
}