Delete account metadata
delete-account-metadataDelete one of the account's own metadata field definitions.
Use this tool when:
The user explicitly asks to delete a metadata field
metadata_uuid comes from list-account-metadata, and the user must have made clear which field they mean - either
by naming it, or because it is the field this conversation has been about. Ask which one they mean when that is not
clear, offering the candidates by their display name.
Deleting a field also removes every value recorded for it, on every document and template in the account, and none
of that can be brought back. So deleting a field the account has recorded values for is refused until the user has
confirmed it: the refusal names the field and how many documents and templates hold a value for it - then repeat
the call with confirmed_deleting_values_in_use: true once they have confirmed it. Send that only in answer to
such a refusal, never as a matter of course.
Put the effect to the user in their own terms and ask before going ahead - "deleting Discount Rate would also remove the value 12 documents hold for it, shall I go ahead?" - rather than quoting the refusal back at them. Name the field you are about to delete either way, and never delete more than the user asked for.
Where the user wants a field to stop being filled in rather than to lose what it already holds, clear its prompt
with update-account-metadata instead: that takes the field out of fynk's AI analyses and leaves the values on their
documents alone.
Only the account's own fields can be deleted. fynk's system fields are provided to every account and cannot be
removed, system_reference fields included - use update-account-metadata to change how one of those is configured
for this account.
Deletion is refused while a bulk metadata operation is still running for the field.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| metadata_uuid | Yes | UUID of the metadata field to delete, as returned by list-account-metadata | |
| confirmed_deleting_values_in_use | No | Only in answer to a refusal naming how many documents and templates hold a value for the field: true states that the user has been told what the deletion takes with it and has confirmed it. Leave it out otherwise |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| removed_values | No | What the deletion took with the field, to report back to the user | |
| deleted_metadata | No |