Update template party
update-template-partyUpdate an existing party on a template.
Use this tool when:
The user wants to change a party's role label, entity details, or scope
The user wants to link an existing external party to a saved account party, or unlink it again
Only send the fields you want to change. reference is the party's role label on the template (e.g. "Employer").
Account party linkage:
Send
account_party_uuid(from list-account-parties) to link the party to a saved account party. While linked, onlyreferencemay be changed;entity_name,address, andscopecannot be sent.Send
account_party_uuidas null to unlink the party, turning it back into an external party whose entity details and scope you can then set.
Use get-template-info to discover the parties on a template and their UUIDs.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scope | No | When internal_and_external, collaborators from this party may change the party's information. Only for external (non account-linked) parties. | |
| address | No | Party's address. Only for external (non account-linked) parties. | |
| reference | No | Generic reference for the party's role on the template. e.g. "Counterparty", "Customer", "Employer" | |
| party_uuid | Yes | UUID of the party to update (use get-template-info to find it) | |
| entity_name | No | Actual name of the party. Only for external (non account-linked) parties. | |
| template_uuid | Yes | UUID of the template the party belongs to | |
| account_party_uuid | No | UUID of a saved account party (from list-account-parties) to link this party to. Send null to unlink. While linked, only reference may be changed. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| uuid | No | Identifier for the party - unique to the specific instance of the party. Do not show to the user unless they ask for it | |
| address | No | The party's address. Absent when not yet known | |
| ref_uuid | No | A static reference identifier, allowing parties in documents to be matched their corresponding party in the document's source template. Do not show to the user unless they ask for it | |
| reference | No | A generic reference for the party. e.g. "Customer", "Employee", etc | |
| entity_name | No | The actual name of the party. Absent when not yet known | |
| is_internal | No | True if the party belongs to this account | |
| _entity_type | No | Only relevant for tooling. Do not show to the user |