Update account document type
update-account-document-typeChange a document type the account can see, whether it is one of the account's own types or one of fynk's system document types.
Use this tool when:
The user asks to rename a document type, or to change what it covers
AI analyses keep picking the wrong document type, or miss one, and its
promptneeds sharpeningThe user asks to change which metadata fields are relevant for documents of a type
The user asks to put one of fynk's document types back to how fynk provides it
The user asks to bring back one of fynk's document types that was removed from the account
document_type_uuid comes from list-account-document-types; request include=["details"] there to see a type's
current description and prompt. Send only the arguments that should change; everything left out keeps its
current value. Sending null for description or prompt clears it.
list-account-document-types marks fynk's own document types with provided_by_fynk, and those this account has
customised with customised as well. A change to one of fynk's types applies to this account alone. The first
change to one that is not customised yet replaces it, for this account, with a customised copy that has a uuid of
its own, and moves the account's documents and templates onto it; use the uuid this tool returns from then on. That
first change must include name, because the copy carries its name as written here in every language the account's
users read fynk in, instead of fynk's translations. So send the name the user knows the type by, e.g.
"Non-Disclosure Agreement", rather than a respelling of the listed name.
Send reset_to_fynk_default: true on its own for a customised type to drop the customisation, putting fynk's own
name, description and prompt back and moving the documents and templates back onto it. The type's uuid changes
back to fynk's, which this tool returns.
A type that list-account-document-types reports as deactivated (with filter_state "deactivated" or "all") is one
of fynk's that was removed from the account. Send reactivate: true on its own to bring it back as fynk provides
it; customise it afterwards with a further call.
prompt is what fynk's AI analyses read when deciding whether a document is of this type. Phrase it as a
selection criterion, the way fynk's own types do: "Select this type if the document defines the terms under which
a tenant rents property from a landlord, including rent amount, duration, deposit, and usage conditions."
relevant_metadata_uuids replaces the metadata fields specifically relevant for the type, which decides the fields
fynk's AI analyses look for in documents of this type. Send every field that should remain: one left out is no
longer extracted from the type's documents, though values already recorded stay. Fields relevant for every
document type apply regardless and are unaffected. list-account-metadata reports the current state: each field
there names the document types it is relevant for.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | New name of the document type, unique among the account's document types, in Title Case (max 255 characters), e.g. "Supplier Framework Agreement". Required on the first change to one of fynk's document types | |
| prompt | No | Selection criterion the AI analyses use to decide whether a document is of this type (max 1024 characters), phrased like "Select this type if the document ...". null clears it, after which the analyses rarely pick the type | |
| reactivate | No | Only true, sent on its own: brings back one of fynk's document types that is deactivated for this account, with its default settings | |
| description | No | One sentence describing what the document type covers, shown to users (max 1024 characters). null clears it | |
| document_type_uuid | Yes | Uuid of the document type to change, from list-account-document-types | |
| reset_to_fynk_default | No | Only true, sent on its own: drops the account's customisation of one of fynk's document types, returning it to fynk's own configuration and uuid | |
| relevant_metadata_uuids | No | Replaces the fields specifically relevant for this document type: uuids from list-account-metadata, of the account's own fields and system_reference fields. Send every field that should remain; an empty list or null leaves only the fields relevant for every document type |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Name of the document type | |
| uuid | No | Identifier for the document type. Do not show to the user unless they ask for it | |
| prompt | No | The selection criterion fynk's AI analyses use to decide whether a document is of this type. Absent when it has none, in which case the analyses rarely pick the type. | |
| customised | No | Present, and true, only for a system document type that this account has customised. The customisation can be dropped again with update-account-document-type and `reset_to_fynk_default` | |
| description | No | What the document type covers, as shown to users configuring it. Absent when it has none. | |
| _entity_type | No | Only relevant for tooling. Do not show to the user | |
| provided_by_fynk | No | Present, and true, only for one of fynk's built-in system document types. The account can customise or deactivate such a type but never delete it. Absent for a type the account created itself |