Document Operations

Update document

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

PUT

/documents/{document}

Update document

curl --request PUT \
  --url https://app.fynk.com/v1/api/documents/{document} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document_type_uuid": "58ac52bb-8885-4580-88c1-7a7bc772c87d",
  "external_signatory_invitation_message": "<string>",
  "name": "Kundenvertrag Muster GmbH",
  "sequential_signing": true,
  "signature_type": "aes"
}
'

{
  "data": {
    "archived_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "document_type_uuid": "58ac52bb-8885-4580-88c1-7a7bc772c87d",
    "dynamic_fields": [
      {
        "autofill_type": "document_created_date",
        "format": {
          "decimal_separator": ".",
          "decimals": 2,
          "thousands_separator": ","
        },
        "is_mandatory": true,
        "name": "Gross salary",
        "order": 123,
        "question": "What is the employee's gross salary in EUR?",
        "question_external": "<string>",
        "ref_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "scope": "internal",
        "select_values": [
          "<string>"
        ],
        "settings": {
          "currencies": [
            "EUR",
            "USD"
          ]
        },
        "type": "id",
        "uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc",
        "value": "EUR;95000;yearly"
      }
    ],
    "external_signatory_invitation_message": "<string>",
    "integration_reference": {
      "external_id": "000000000000Abc",
      "external_name": "Example Opportunity",
      "integration_type": "pipedrive",
      "object_type": "Opportunity"
    },
    "locale": "de-AT",
    "metadata_values": [
      {
        "computed_at": "2023-11-07T05:31:56Z",
        "computed_status": "missing_information",
        "computed_value": "EUR;95000;yearly",
        "is_attached": true,
        "metadata": {
          "always_exists": true,
          "description": "The discount rate applied to the company valuation in a follow-on financing round.",
          "display_name": "Discount Rate",
          "is_contract_value": true,
          "keywords": "discount, rate, valuation",
          "name": "discount_rate",
          "prompt": "Extract the discount rate percentage from the document.",
          "relevant_document_type_uuids": [
            "<string>"
          ],
          "select_values": [
            "<string>"
          ],
          "settings": {
            "currencies": [
              "EUR",
              "USD"
            ]
          },
          "type": "system_autofilled",
          "uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc",
          "value_type": "id"
        },
        "reference_dynamic_field_uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc",
        "uuid": "4ed6c60b-bc4f-4390-bbf5-ed384e3443c9",
        "value": "EUR;95000;yearly",
        "value_currency_monthly": "<string>",
        "value_currency_yearly": "<string>",
        "value_source": "user"
      }
    ],

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

Autorisierungen

Authorizationstringheadererforderlich

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

Pfadparameter

documentstringerforderlich

The document UUID

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

Beispiel: 58ac52bb-8885-4580-88c1-7a7bc772c87d

external_signatory_invitation_messagestring | null

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

Maximum string length: 65535

namestring

Must be a non-empty string.

Maximum string length: 255

Beispiel: Kundenvertrag Muster GmbH

sequential_signingboolean

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

signature_typeenum<string>

Controls which signature type will be used during signing. Cannot be changed if signing has started or if the value is inherited from a template

Verfügbare Optionen: aes, aes_eid, qes, ses

Antwort

DocumentDetailResource

dataobjecterforderlich

child attributes anzeigen

Brauchen Sie noch Hilfe? Team fragen

Autorisierungen

Pfadparameter

Body

Antwort