---
canonical_url: "https://docs.composio.dev/toolkits/fynk"
markdown_url: "https://docs.composio.dev/toolkits/fynk.md"
product: "platform"
version: null
last_updated: null
---

# fynk

fynk is a contract management platform for creating, reviewing, signing, and organizing documents and templates.

- **Category:** documents
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 73
- **Triggers:** 0
- **Slug:** `FYNK`
- **Version:** 00000000_00

## Tools

### Add Document Attachment

**Slug:** `FYNK_ADD_DOCUMENT_ATTACHMENT`

Add a previously uploaded file as an attachment visible as part of a document. This action does not upload bytes to the presigned storage URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_name` | string | Yes | Name for the document attachment. |
| `document_uuid` | string | Yes | UUID of the document to attach the uploaded file to. |
| `file_upload_uuid` | string | Yes | UUID returned by Create Document Attachment Upload URL after upload completes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Document Metadata Value

**Slug:** `FYNK_ADD_DOCUMENT_METADATA_VALUE`

Attach one metadata definition to a document and optionally set its initial value.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | string | No | Initial value. Omit or pass null to attach the metadata without a value. |
| `document_uuid` | string | Yes | UUID of the document to which the metadata value will be added. |
| `metadata_uuid` | string | Yes | UUID of the metadata definition to attach to the document. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Document Party

**Slug:** `FYNK_ADD_DOCUMENT_PARTY`

Add a represented person or organization to a document. This changes the document's parties but does not grant a user access.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope` | string ("internal" | "internal_and_external") | No | Whether collaborators may edit party information. Required for a standalone party. |
| `address` | string | No | Party address, or null to leave it unset. |
| `reference` | string | Yes | Generic reference for the party. |
| `entity_name` | string | No | Person or organization name. It must be set before the document can enter signing. |
| `document_uuid` | string | Yes | UUID of the document to add a party to. |
| `account_party_uuid` | string | No | UUID of a party from Settings > My Parties. When provided, only reference may accompany it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Document Signatory

**Slug:** `FYNK_ADD_DOCUMENT_SIGNATORY`

Add a person who will sign for an existing document party. This only assigns the signatory and does not send an invitation; invitations are sent when the document is separately sent for signing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address of the signatory. |
| `title` | string | No | Signatory's job title. Ignored when the email belongs to an existing account user. |
| `last_name` | string | No | Signatory's last name. Ignored when the email belongs to an existing account user. |
| `first_name` | string | No | Signatory's first name. Ignored when the email belongs to an existing account user. |
| `party_uuid` | string | Yes | UUID of the document party the signatory will sign for. |
| `mobile_phone` | string | No | Signatory's mobile phone number in E.164 format. |
| `document_uuid` | string | Yes | UUID of the document to add the signatory to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Document User

**Slug:** `FYNK_ADD_DOCUMENT_USER`

Grant a user access to a document as owner, collaborator, or viewer. By default fynk immediately emails an invitation; choose personal_link or none explicitly to avoid that email.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role` | string ("owner" | "collaborator" | "viewer") | Yes | Access level to grant. Only an existing account user can become owner. |
| `email` | string | Yes | Email address of the user receiving access. |
| `title` | string | No | Job title, or null. Ignored for an existing account user. |
| `last_name` | string | No | Last name, or null. Ignored for an existing account user. |
| `first_name` | string | No | First name, or null. Ignored for an existing account user. |
| `party_uuid` | string | No | Document party the user belongs to, or null for no party assignment. |
| `document_uuid` | string | Yes | UUID of the document to grant the user access to. |
| `invite_method` | string ("fynk_email" | "personal_link" | "none") | No | How access is delivered: fynk_email sends an invitation immediately, personal_link creates a secret URL returned in the response, and none grants access silently. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive Document

**Slug:** `FYNK_ARCHIVE_DOCUMENT`

Archive a document without deleting it; use Unarchive Document to restore it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of the document to archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Clone Global Template

**Slug:** `FYNK_CLONE_GLOBAL_TEMPLATE`

Create an account template from a global template after accepting its attribution and license terms. fynk publishes the clone by default; set published to false to create a draft instead.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Optional name for the clone; omit to retain the global-template name. |
| `published` | boolean | No | Whether to publish the clone immediately. Omit or pass true to publish it by default; pass false to keep the clone as a draft. |
| `team_uuids` | array | No | Teams to assign to the cloned template. |
| `terms_confirmed` | boolean | Yes | Must be true to confirm acceptance of the template's attribution and license terms. |
| `global_template_uuid` | string | Yes | UUID of the global template to clone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Document Attachment Upload URL

**Slug:** `FYNK_CREATE_DOCUMENT_ATTACHMENT_UPLOAD_URL`

Create a temporary presigned form for a file that will later be added as a document attachment. This helper returns the upload URL and fields but does not send file bytes to external storage.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `content_type` | string ("application/pdf" | "application/msword" | "application/vnd.openxmlformats-officedocument.wordprocessingml.document" | "application/xml" | "application/vnd.ms-excel" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" | "application/vnd.ms-powerpoint" | "application/vnd.openxmlformats-officedocument.presentationml.presentation" | "text/csv" | "text/plain" | "message/rfc822" | "image/jpeg" | "image/png" | "image/webp" | "image/gif") | Yes | MIME type of the attachment that will be uploaded. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Document File Storage Upload URL

**Slug:** `FYNK_CREATE_DOCUMENT_FILE_STORAGE_UPLOAD_URL`

Create a temporary presigned form for a file that will later be associated with document file storage. This helper returns the upload URL and fields but does not send file bytes to external storage.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `content_type` | string | Yes | MIME type of the file that will be uploaded. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Document From PDF

**Slug:** `FYNK_CREATE_DOCUMENT_FROM_PDF`

Create a fynk document from a PDF that was uploaded using Create Document PDF Upload URL. This action associates an already uploaded file; it does not upload file bytes to the presigned storage URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Document name. When omitted, fynk uses the PDF file name. |
| `file_name` | string | Yes | Name of the uploaded PDF file. |
| `tag_uuids` | array | No | Tag UUIDs to assign to the document. |
| `team_uuids` | array | No | Team UUIDs that should have access to the document. |
| `owner_emails` | array | No | Workspace user email addresses that should own the new document. |
| `initial_stage` | string ("draft" | "done") | Yes | Lifecycle stage in which to create the document: draft or done. |
| `template_uuid` | string | No | Template UUID whose settings should be copied to the new document. |
| `file_upload_uuid` | string | Yes | UUID returned by Create Document PDF Upload URL after the PDF upload completes. |
| `account_party_uuid` | string | No | UUID of an account party involved in the document. |
| `ai_analysis_auto_apply` | boolean | No | Whether fynk should automatically apply AI analysis results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Document From Template

**Slug:** `FYNK_CREATE_DOCUMENT_FROM_TEMPLATE`

Create a document from an account template, optionally filling fields, parties, owners, and signatories. initial_stage=signing immediately starts signing and emails invitations; use draft to prepare the document first. This endpoint was observed to allow only 2 requests per rolling minute, so avoid speculative calls and automatic retries that could create duplicates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name for the new document; defaults to the template name. |
| `parties` | object | No | Party values keyed by a template party ref_uuid, reference, or entity name. The provider's authoritative request example and description require this keyed object shape. |
| `signatories` | object | No | Signatories keyed by their template party ref_uuid, reference, or entity name. Each keyed value is a list, and these signatories are added to any already on the template. |
| `owner_emails` | array | No | Email addresses of workspace users who should own the new document. |
| `initial_stage` | string ("draft" | "signing") | No | Initial lifecycle stage. signing immediately starts the external signing process and emails invitations; use draft to prepare the document first. |
| `template_uuid` | string | Yes | UUID of the account template returned by List Templates. |
| `dynamic_field_values` | object | Yes | Initial dynamic-field values keyed by each template field's ref_uuid or name. Pass an empty object when no values are needed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Document PDF Upload URL

**Slug:** `FYNK_CREATE_DOCUMENT_PDF_UPLOAD_URL`

Create a temporary presigned form for uploading a PDF that will later be used by Create Document From PDF. This helper returns the upload URL and fields but does not send file bytes to external storage.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Document Public Link

**Slug:** `FYNK_CREATE_DOCUMENT_PUBLIC_LINK`

Create a secret URL that grants anyone possessing it public view access to the document. It does not grant edit access; distribute it carefully and revoke it when no longer needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expires_at` | string | No | ISO 8601 expiry. Omit for fynk's three-month default; pass null for no expiry. |
| `document_uuid` | string | Yes | UUID of the document for which to create public view access. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Document User Personal Link

**Slug:** `FYNK_CREATE_DOCUMENT_USER_PERSONAL_LINK`

Create a secret URL that grants one document user access. Anyone possessing the URL can use that access; deliver it securely and revoke it when no longer needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message` | string | No | Personal message shown when the user opens the link, or null for none. |
| `expires_at` | string | No | ISO 8601 expiry. Omit for fynk's three-month default; pass null for no expiry. |
| `document_uuid` | string | Yes | UUID of the document for which to create a user-specific link. |
| `document_user_uuid` | string | Yes | UUID of the document user who will receive access through the link. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Metadata Definition

**Slug:** `FYNK_CREATE_METADATA_DEFINITION`

Create a custom account metadata definition. Its value type and programmatic name cannot be changed later.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique immutable lowercase programmatic name containing only letters, digits, and underscores. |
| `prompt` | string | No | AI prompt used for metadata extraction. |
| `keywords` | string | No | Keywords used to identify the metadata. |
| `value_type` | string ("bool" | "date" | "duration" | "email" | "number" | "currency" | "currency_duration" | "clause" | "select" | "multi_select" | "text" | "textarea" | "timestamp") | Yes | Immutable value type for the metadata definition. |
| `description` | string | No | Description of the metadata field. |
| `display_name` | string | Yes | Display name shown in fynk. |
| `select_values` | array | No | Allowed values for select or multi_select metadata. |
| `is_contract_value` | boolean | No | Whether this contributes to contract value; true is valid only for currency types. |
| `relevant_document_type_uuids` | array | No | Relevant document types; null means none and an empty list means all. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Tag

**Slug:** `FYNK_CREATE_TAG`

Create a reusable tag in the connected fynk account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Tag name. |
| `color` | string | Yes | Tag color as a lowercase six-digit hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Latest Document Revision PDF

**Slug:** `FYNK_DOWNLOAD_LATEST_DOCUMENT_REVISION_PDF`

Download the latest PDF revision of a document. fynk redirects this request to the PDF content, which is returned as a downloadable file reference.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of the document whose latest revision PDF to download. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Current API Token Details

**Slug:** `FYNK_GET_CURRENT_API_TOKEN_DETAILS`

Inspect the current fynk API token, connected account, API versions, expiration, and permission-dependent links.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Document

**Slug:** `FYNK_GET_DOCUMENT`

Return full details for one document, including its current lifecycle, signing configuration, parties, signatories, fields, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of the document to inspect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Document Attachment Download

**Slug:** `FYNK_GET_DOCUMENT_ATTACHMENT_DOWNLOAD`

Return attachment details and a temporary provider-managed download URL. The action does not follow the URL or buffer the file content.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of the document containing the attachment. |
| `attachment_uuid` | string | Yes | UUID of the attachment whose temporary download URL to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Document Comment

**Slug:** `FYNK_GET_DOCUMENT_COMMENT`

Retrieve one comment or proposed change from a document by UUID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `comment_uuid` | string | Yes | UUID of the comment to retrieve. |
| `document_uuid` | string | Yes | UUID of the document containing the comment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Document Public Link

**Slug:** `FYNK_GET_DOCUMENT_PUBLIC_LINK`

Retrieve the document's active public view-access link. Anyone possessing the returned secret URL can view the document, so do not publish it unintentionally.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of the document whose public link to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Document Stored File Download

**Slug:** `FYNK_GET_DOCUMENT_STORED_FILE_DOWNLOAD`

Return stored-file details and a temporary provider-managed download URL. The action does not follow the URL or buffer the file content.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of the document containing the stored file. |
| `stored_file_uuid` | string | Yes | UUID of the stored file whose temporary download URL to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Document User Personal Link

**Slug:** `FYNK_GET_DOCUMENT_USER_PERSONAL_LINK`

Retrieve the active secret access link assigned to one document user. Treat the returned URL as a credential and do not publish it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of the document whose user-specific link to retrieve. |
| `document_user_uuid` | string | Yes | UUID of the document user whose personal link to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Global Template

**Slug:** `FYNK_GET_GLOBAL_TEMPLATE`

Inspect one global fynk template, including its author attribution, license terms, locale, and parties before cloning it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_uuid` | string | Yes | UUID of the global template to inspect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Latest Document Revision PDF

**Slug:** `FYNK_GET_LATEST_DOCUMENT_REVISION_PDF`

Return metadata and a short-lived, pre-authenticated download URL for a document's latest PDF revision.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of the document whose latest revision PDF details to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Template

**Slug:** `FYNK_GET_TEMPLATE`

Return full configuration for one account template, including parties and any included teams, signatories, fields, metadata, and tags.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_uuid` | string | Yes | UUID of the account template to inspect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Link Documents

**Slug:** `FYNK_LINK_DOCUMENTS`

Create a directional relationship between two documents, such as parent-child, amendment, renewal, addition, replacement, or termination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of the document from whose perspective to create the relationship. |
| `relationship_type` | string ("parent_of" | "child_of" | "amendment_to" | "amended_by" | "renewal_of" | "renewed_by" | "addition_to" | "added_to_by" | "replacement_of" | "replaced_by" | "termination_of" | "terminated_by") | Yes | Relationship from the URL document to the other document. fynk normalizes the directional value in the response. |
| `other_document_uuid` | string | Yes | UUID of the other document to link. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Document Attachments

**Slug:** `FYNK_LIST_DOCUMENT_ATTACHMENTS`

List files attached to and visible as part of a document. These differ from internal files in the document's file storage.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of the document whose signed-document attachments to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Document Comments

**Slug:** `FYNK_LIST_DOCUMENT_COMMENTS`

List comments and proposed changes on a document, with optional status, visibility, type, and sorting filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("comment" | "proposal") | No | Filter by regular comments or proposed changes. |
| `scope` | string ("internal" | "internal_and_external") | No | Filter comments by their visibility scope. |
| `sort_by` | string ("created_at" | "updated_at") | No | Field used to sort comments. The provider defaults to updated_at. |
| `document_uuid` | string | Yes | UUID of the document whose comments to list. |
| `sort_direction` | string ("asc" | "desc") | No | Sort direction. The provider defaults to desc. |
| `resolution_status` | string ("open" | "resolved") | No | Filter comments by open or resolved status. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Document Conditions

**Slug:** `FYNK_LIST_DOCUMENT_CONDITIONS`

List a document's conditions and whether each currently applies based on its dynamic-field values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of the document whose conditions to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Document Dynamic Fields

**Slug:** `FYNK_LIST_DOCUMENT_DYNAMIC_FIELDS`

Return a document's dynamic fields, current values, and visibility so required contract data can be inspected before signing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `visibility` | string ("all" | "visible" | "not_visible") | No | Filter fields by whether they appear in the document: visible, not_visible, or all. Omit to return all fields. |
| `document_uuid` | string | Yes | UUID of the document whose dynamic fields to inspect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Document Metadata Values

**Slug:** `FYNK_LIST_DOCUMENT_METADATA_VALUES`

List the metadata definitions and current values attached to a document.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of the document whose metadata values to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Document Parties

**Slug:** `FYNK_LIST_DOCUMENT_PARTIES`

Return the legal entities or people represented as parties on a document.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of the document whose parties to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Documents

**Slug:** `FYNK_LIST_DOCUMENTS`

Find documents in the connected fynk workspace, with optional search, lifecycle, template, tag, and team filters; returns one page and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Search document names, content, metadata, and parties. |
| `stages` | array | No | Document stages to include, such as draft, review, signing, or done. |
| `expired` | boolean | No | When true, return documents whose expiration date is in the past. |
| `origins` | array | No | Match documents created from any of these origins. |
| `sort_by` | string | No | Sort field: name, stage, created_at, updated_at, archived_at, relevance, or a metadata name. Omit to use provider ordering; text searches then use relevance. |
| `archived` | boolean | No | When set, filter by archived state. |
| `per_page` | integer | No | Maximum documents to return in this page. |
| `tag_uuids` | array | No | Match documents carrying any of these tag UUIDs. |
| `team_uuids` | array | No | Match documents assigned to any of these team UUIDs. |
| `discussions` | string ("has_any" | "has_open") | No | Match documents with any discussion or at least one open discussion. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `document_users` | array | No | Match documents involving any of these names in Firstname_Lastname format. |
| `sort_direction` | string ("asc" | "desc") | No | Sort direction. Omit to use the provider default. |
| `template_uuids` | array | No | Match documents created from any of these template UUIDs. |
| `team_unassigned` | boolean | No | When true, include documents with no team; may be combined with team_uuids. |
| `metadata_filters` | string | No | JSON object mapping metadata programmatic names to filter strings. Values follow each metadata type's documented syntax; entries are sent as filter[name]. |
| `require_all_tags` | boolean | No | When true, require documents to have all tag_uuids instead of any tag. |
| `excluded_tag_uuids` | array | No | Exclude documents carrying any of these tag UUIDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Document Signatories

**Slug:** `FYNK_LIST_DOCUMENT_SIGNATORIES`

Return a document's signatories, their represented parties, signing order, and contact details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of the document whose signatories to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Document Stored Files

**Slug:** `FYNK_LIST_DOCUMENT_STORED_FILES`

List internal working files in a document's file storage. These files are not attachments and are not visible as part of the signed document.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of the document whose internal file storage to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Document Types

**Slug:** `FYNK_LIST_DOCUMENT_TYPES`

List the document types available for classifying fynk documents.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Document Users

**Slug:** `FYNK_LIST_DOCUMENT_USERS`

List users with document access, optionally filtered by owner, collaborator, or viewer role.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role` | string ("owner" | "collaborator" | "viewer") | No | Return only users with this document access role. |
| `document_uuid` | string | Yes | UUID of the document whose users to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Linked Documents

**Slug:** `FYNK_LIST_LINKED_DOCUMENTS`

List a document's normalized relationships to parent, amendment, renewal, addition, replacement, and termination documents.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of the document whose relationships to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Metadata Definitions

**Slug:** `FYNK_LIST_METADATA_DEFINITIONS`

List all system and account metadata definitions available for fynk documents.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tags

**Slug:** `FYNK_LIST_TAGS`

List one page of tags in the connected fynk account and return a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort_by` | string | No | Sort field; fynk currently supports only name. |
| `per_page` | integer | No | Number of tags to return (1-100). |
| `next_cursor` | string | No | Continuation cursor from a previous call; omit for the first page. |
| `sort_direction` | string ("asc" | "desc") | No | Sort direction; the provider defaults to ascending. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Teams

**Slug:** `FYNK_LIST_TEAMS`

List one page of teams that can be assigned to fynk documents and templates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort_by` | string ("name" | "created_at") | No | Field used to sort teams; the provider defaults to name. |
| `per_page` | integer | No | Number of teams to return (1-100). |
| `next_cursor` | string | No | Continuation cursor from a previous call; omit for the first page. |
| `sort_direction` | string ("asc" | "desc") | No | Sort direction; the provider defaults to ascending. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Templates

**Slug:** `FYNK_LIST_TEMPLATES`

Find account templates that can be used to create documents; returns one page and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Match template names containing this text. |
| `locale` | string | No | Filter by a two-letter locale with an optional uppercase region code. |
| `status` | string ("draft" | "published") | No | Filter templates by publication status. |
| `sort_by` | string ("name" | "created_at" | "updated_at" | "archived_at") | No | Field used to sort templates. |
| `archived` | boolean | No | When set, filter by archived state. |
| `per_page` | integer | No | Maximum templates to return in this page. |
| `tag_uuids` | array | No | Match templates carrying any of these tag UUIDs. |
| `team_uuids` | array | No | Match templates assigned to any of these team UUIDs. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `sort_direction` | string ("asc" | "desc") | No | Sort direction. |
| `team_unassigned` | boolean | No | When true, include templates with no team; may be combined with team_uuids. |
| `require_all_tags` | boolean | No | When true, require templates to have all tag_uuids instead of any tag. |
| `excluded_tag_uuids` | array | No | Exclude templates carrying any of these tag UUIDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark Document Done

**Slug:** `FYNK_MARK_DOCUMENT_DONE`

Move a draft, approved draft, review, or approved review document directly to done when it will not be signed through fynk. Do not use this for documents that should enter fynk's signing flow; those become done automatically after all signatures are complete. Missing mandatory fields, unresolved changes, active editing, or blocking checkpoints can prevent the transition.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of an unsigned draft or review-stage document to mark done without using fynk's signing process. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Move Document to Review and Cancel Signing

**Slug:** `FYNK_MOVE_DOCUMENT_TO_REVIEW_AND_CANCEL_SIGNING`

Move a draft, approved draft, approved review, signing, or done document to review. For a signing or done document, this irreversibly cancels the current signing process and invalidates every existing signature. Blocked checkpoints prevent the transition.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of the document to move to review. If signing has started or finished, this cancels signing and invalidates existing signatures. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Permanently and Irreversibly Delete Document

**Slug:** `FYNK_PERMANENTLY_DELETE_DOCUMENT`

Permanently and irreversibly delete a fynk document. This destructive operation cannot be undone and the document cannot be restored through fynk or the API; use Archive Document instead when recovery may be needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of the document to permanently and irreversibly delete. The document cannot be restored after this operation; archive it instead when retention or recovery may be needed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Permanently Delete Metadata Definition and All Values

**Slug:** `FYNK_PERMANENTLY_DELETE_METADATA_DEFINITION_AND_VALUES`

Permanently and irreversibly delete an account metadata definition and every value stored for it on documents. This destructive action cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `metadata_uuid` | string | Yes | UUID of the metadata definition to permanently delete together with all of its document values. This cannot be undone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Permanently and Irreversibly Delete Tag

**Slug:** `FYNK_PERMANENTLY_DELETE_TAG`

Permanently and irreversibly delete a fynk tag. This destructive action cannot be undone and may remove the tag from associated resources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_uuid` | string | Yes | UUID of the tag to permanently delete. This cannot be undone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Permanently Remove Document Attachment

**Slug:** `FYNK_PERMANENTLY_REMOVE_DOCUMENT_ATTACHMENT`

Permanently remove an attachment from a document. This destructive operation cannot be undone; use only the exact attachment UUID the caller intends to remove.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of the document containing the attachment. |
| `attachment_uuid` | string | Yes | UUID of the attachment to permanently remove from the document. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Document Metadata Value

**Slug:** `FYNK_REMOVE_DOCUMENT_METADATA_VALUE`

Destructively remove one exact metadata value from a document. For always-existing metadata, fynk detaches it and restores its default value.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of the document from which the metadata value will be removed. |
| `metadata_value_uuid` | string | Yes | Exact UUID of the document metadata value to permanently remove or detach. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Document Signatory

**Slug:** `FYNK_REMOVE_DOCUMENT_SIGNATORY`

Remove a signatory from a fynk document so that person no longer participates in signing. This changes the document's signing participants; fynk may reject removal after signing has started.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of the document containing the signatory. |
| `signatory_uuid` | string | Yes | UUID of the signatory to remove. After removal, this person will no longer participate in the document's signing process. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Document User And Revoke Access

**Slug:** `FYNK_REMOVE_DOCUMENT_USER_AND_REVOKE_ACCESS`

Remove a user from a document, revoke their access, and remove their signatory status. To remove only signatory status while retaining document access, use REMOVE_DOCUMENT_SIGNATORY instead.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of the document from which to remove the user. |
| `document_user_uuid` | string | Yes | UUID of the user whose document access will be revoked. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rename Document Attachment

**Slug:** `FYNK_RENAME_DOCUMENT_ATTACHMENT`

Change the file name of an existing document attachment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_name` | string | Yes | New file name for the attachment. |
| `document_uuid` | string | Yes | UUID of the document containing the attachment. |
| `attachment_uuid` | string | Yes | UUID of the attachment to rename. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Revoke Document Public Link

**Slug:** `FYNK_REVOKE_DOCUMENT_PUBLIC_LINK`

Revoke the document's public link so its secret URL no longer grants public view access. Create a new link if public view access is needed again; this action does not change named-user or edit access.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of the document whose public link to revoke. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Revoke Document User Personal Link

**Slug:** `FYNK_REVOKE_DOCUMENT_USER_PERSONAL_LINK`

Permanently revoke the secret personal link for one document user so the URL no longer grants access. This cannot be undone; a new link must be created if access is needed again.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of the document whose personal link to revoke. |
| `document_user_uuid` | string | Yes | UUID of the document user whose link access will be revoked. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Document For Signing

**Slug:** `FYNK_SEND_DOCUMENT_FOR_SIGNING`

Move a prepared document to signing and immediately email invitations to its signatories. A successful call starts the external signing process immediately; use only after confirming required fields, parties, signatories, and signature settings are ready.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message` | string | No | Extra text included in the invitation emails sent immediately by this action. When omitted, fynk uses the document's default invitation message. |
| `document_uuid` | string | Yes | UUID of the prepared document to move to signing. A successful call immediately starts signing and emails invitations to its signatories. |
| `signature_type` | string ("aes" | "aes_eid" | "qes" | "ses") | No | Signature security level to use when the document does not already set one. If the document has a different non-null value, fynk rejects the request. |
| `sequential_signing` | boolean | No | Whether invitations proceed in each signatory's signing_order. qes and aes_eid require true; when omitted, fynk uses the document's setting. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Document Signing Order

**Slug:** `FYNK_SET_DOCUMENT_SIGNING_ORDER`

Set the order in which every signatory signs a document when sequential signing is enabled. Supply every signatory UUID and call this before signing starts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of the document whose signatories to reorder. |
| `signing_order` | array | Yes | UUIDs of all document signatories in their requested signing order. This only affects sequential signing and must be set before signing starts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Store Document File

**Slug:** `FYNK_STORE_DOCUMENT_FILE`

Associate a previously uploaded file with a document's internal file storage. This action does not upload bytes to the presigned storage URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_name` | string | Yes | Name for the file in the document's internal storage. |
| `document_uuid` | string | Yes | UUID of the document in whose internal file storage to keep the file. |
| `file_upload_uuid` | string | Yes | UUID returned by Create Document File Storage Upload URL after upload completes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unarchive Document

**Slug:** `FYNK_UNARCHIVE_DOCUMENT`

Restore an archived document to the active document collection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of the archived document to restore. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unlink Documents

**Slug:** `FYNK_UNLINK_DOCUMENTS`

Remove one relationship between documents using the exact relationship UUID returned by List Linked Documents. The relationship can be recreated later, and neither document is deleted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_uuid` | string | Yes | UUID of a document in the relationship to remove. |
| `document_relationship_uuid` | string | Yes | UUID of the exact document relationship to permanently unlink, obtained from List Linked Documents. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Document

**Slug:** `FYNK_UPDATE_DOCUMENT`

Update a document's name, type, signing mode, signature security level, or invitation message before provider stage rules lock those settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New non-empty document name. |
| `document_uuid` | string | Yes | UUID of the document to update. |
| `signature_type` | string ("aes" | "aes_eid" | "qes" | "ses") | No | Signature security level; provider rules may prevent changes after signing starts or when inherited from a template. |
| `document_type_uuid` | string | No | Document type UUID to assign; explicitly pass null to remove the current type. |
| `sequential_signing` | boolean | No | Whether signatories must sign in signing_order; cannot change after signing starts. |
| `external_signatory_invitation_message` | string | No | Default extra text for future signatory invitation emails; explicitly pass null to clear it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Document Dynamic Field

**Slug:** `FYNK_UPDATE_DOCUMENT_DYNAMIC_FIELD`

Set or clear one dynamic field on a document; use the bulk action to update multiple fields together.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | string | Yes | New value for this field. Use null to clear it where permitted; use the bulk update action when changing multiple fields. |
| `document_uuid` | string | Yes | UUID of the document containing the dynamic field. |
| `dynamic_field_uuid` | string | Yes | UUID of the one dynamic field to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Document Dynamic Fields

**Slug:** `FYNK_UPDATE_DOCUMENT_DYNAMIC_FIELDS`

Set or clear up to 20 dynamic-field values on a document in one call before signing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `values` | object | Yes | One to 20 values keyed by dynamic-field ref_uuid, uuid, or name. Use null only where fynk permits clearing the field. |
| `document_uuid` | string | Yes | UUID of the document whose fields to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Document Metadata Value

**Slug:** `FYNK_UPDATE_DOCUMENT_METADATA_VALUE`

Set or clear one existing metadata value on a document. A value is required and may be explicit null; use the bulk action for multiple values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | string | Yes | New value. Pass null to clear the value where fynk permits it. |
| `document_uuid` | string | Yes | UUID of the document containing the metadata value. |
| `metadata_value_uuid` | string | Yes | UUID of the one document metadata value to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Document Metadata Values

**Slug:** `FYNK_UPDATE_DOCUMENT_METADATA_VALUES`

Apply at least one and up to 20 set or unset metadata-value changes on one document in a single request; empty no-op updates are rejected.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `changes` | array | Yes | One to 20 metadata value set or unset operations. |
| `document_uuid` | string | Yes | UUID of the document whose metadata values to change. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Document Party

**Slug:** `FYNK_UPDATE_DOCUMENT_PARTY`

Update selected details of an existing document party. Internal parties allow only reference updates; entity name, address, and scope updates apply only to external parties.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope` | string ("internal" | "internal_and_external") | No | New party information access scope. Internal parties do not allow this change; only their reference can be updated. |
| `address` | string | No | New party address, or null to clear it. Internal parties do not allow this change; only their reference can be updated. |
| `reference` | string | No | New generic party reference. |
| `party_uuid` | string | Yes | UUID of the party to update. |
| `entity_name` | string | No | New party name, or null to clear it. Internal parties do not allow this change; only their reference can be updated. |
| `document_uuid` | string | Yes | UUID of the document containing the party. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Document Public Link

**Slug:** `FYNK_UPDATE_DOCUMENT_PUBLIC_LINK`

Change the expiry of an existing public view-access link. Omission leaves the expiry unchanged; this keeps the secret view URL active and does not grant edit access.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expires_at` | string | No | New ISO 8601 expiry, or null to make the public link non-expiring. |
| `document_uuid` | string | Yes | UUID of the document whose public link to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Document Signatory

**Slug:** `FYNK_UPDATE_DOCUMENT_SIGNATORY`

Update a document signatory's represented party, name, mobile phone, or title. For signatories linked to account users, only party and mobile phone can change.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | New job title, or null to clear it. Cannot change for account users. |
| `last_name` | string | No | New last name, or null to clear it. Cannot change for account users. |
| `first_name` | string | No | New first name, or null to clear it. Cannot change for account users. |
| `party_uuid` | string | No | New UUID of the document party the signatory represents. |
| `mobile_phone` | string | No | New mobile phone number in E.164 format, or null to clear it. |
| `document_uuid` | string | Yes | UUID of the document containing the signatory. |
| `signatory_uuid` | string | Yes | UUID of the signatory to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Document User Access

**Slug:** `FYNK_UPDATE_DOCUMENT_USER_ACCESS`

Change a document user's access role, party assignment, or editable profile fields. Omitted fields remain unchanged; this does not revoke access.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role` | string ("owner" | "collaborator" | "viewer") | No | New access role. Only an existing account user can become owner. |
| `title` | string | No | New job title, or null to clear it; unavailable for account users. |
| `last_name` | string | No | New last name, or null to clear it; unavailable for account users. |
| `first_name` | string | No | New first name, or null to clear it; unavailable for account users. |
| `party_uuid` | string | No | New document party assignment. |
| `document_uuid` | string | Yes | UUID of the document whose user access to update. |
| `document_user_uuid` | string | Yes | UUID of the document user to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Document User Personal Link

**Slug:** `FYNK_UPDATE_DOCUMENT_USER_PERSONAL_LINK`

Change the expiry or message on an existing user-specific access link. Omitted fields remain unchanged; this keeps the secret URL active.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message` | string | No | New personal message, or null to remove the message. |
| `expires_at` | string | No | New ISO 8601 expiry, or null to make the link non-expiring. |
| `document_uuid` | string | Yes | UUID of the document whose personal link to update. |
| `document_user_uuid` | string | Yes | UUID of the document user whose personal link to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Metadata Definition

**Slug:** `FYNK_UPDATE_METADATA_DEFINITION`

Update at least one mutable presentation, extraction, select, contract-value, or document-type field. Omit unchanged fields; display_name does not accept null.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `prompt` | string | No | New AI extraction prompt; pass null to clear it. |
| `keywords` | string | No | New identification keywords; pass null to clear them. |
| `description` | string | No | New description; pass null to clear it. |
| `display_name` | string | No | New display name. |
| `metadata_uuid` | string | Yes | UUID of the metadata definition to update. |
| `select_values` | array | No | Allowed values for select or multi_select metadata. |
| `is_contract_value` | boolean | No | Whether this contributes to contract value; true is valid only for currency types. |
| `relevant_document_type_uuids` | array | No | Relevant document types; null means none and an empty list means all. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Tag

**Slug:** `FYNK_UPDATE_TAG`

Change at least one field on an existing fynk tag: name or color. Omit unchanged fields; neither field accepts null.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New tag name. |
| `color` | string | No | New lowercase six-digit hexadecimal color. |
| `tag_uuid` | string | Yes | UUID of the tag to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
