Update document
update-documentUpdates a document's name, locale, document type, signing settings and/or external signatory invitation message.
Use this tool when:
A document should be renamed
The document's content language (locale) or document type should change
The signature type or sequential signing setting should change before signing starts
The message included in the email inviting external signatories should be set or changed
All arguments except document_uuid are optional and only need to be sent if their value should change. signature_type and sequential_signing cannot be changed once signing has started, and signature_type cannot be changed if it was specified by the document's template. Use the list-account-document-types tool to discover valid document type UUIDs. This tool cannot change the document's stage (use the move-document-to-*-stage tools for that).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | New name for the document | |
| locale | No | New locale code for the document content, e.g. en-GB, de-AT | |
| document_uuid | Yes | UUID of the document to update. If you don't already have the document's UUID, use the list-documents tool to find it. | |
| signature_type | No | eIDAS assurance level to use when signing the document. aes_eid is only accepted when the account has enabled AES (eID). Cannot be changed once signing has started or if the value was specified by the template | |
| document_type_uuid | No | UUID of the document type to assign. Pass null to remove the current document type. Use the list-account-document-types tool to find valid UUIDs | |
| sequential_signing | No | When true, signatories will sign one at a time, in ascending order of their signing_order. Cannot be changed once signing has started | |
| external_signatory_invitation_message | No | Text to display in the email notification sent to external signatories when the document is ready for signing |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | URL to open the document in fynk | |
| name | No | Name of the document | |
| uuid | No | Unique identifier for the document. Do not show to the user unless they ask for it | |
| stage | No | What stage the document is in currently | |
| locale | No | Locale code, e.g. en-GB, de-AT. Absent when the document has none set. Prefer describing the locale in natural language (e.g. 'British English') rather than showing the raw code. | |
| origin | No | How the document was created. | |
| _entity_type | No | Only relevant for tooling. Do not show to the user | |
| document_type | No | If present, indicates what kind of document this is. Absent when the document has no type assigned | |
| signature_type | No | eIDAS assurance level used when signing the document. Absent when none has been chosen. | |
| sequential_signing | No | When true, signatories sign one at a time, in ascending order of their signing_order. | |
| source_template_uuid | No | UUID of the template the document was created from. Absent when it was not created from a template. | |
| external_signatory_invitation_message | No | Text shown in the email inviting external signatories to sign. Absent when no message is set. |