Update document party
update-document-partyEdit the details of a party on a document.
Use this tool when:
A party's reference, entity type, entity name, address, or scope needs to change on an existing document
document_uuid and party_identifier (a ref_uuid, reference, or entity_name of a party on the document) are required to identify the party. All other arguments are optional and only need to be sent if their value should change. For parties linked to an account party, only party_reference can be changed — attempting to update other fields will fail.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| party_scope | No | New scope. Cannot be set when the party's is_internal is true | |
| document_uuid | Yes | UUID of the document containing the party to update. If you don't already have the document's UUID, use the list-documents tool to find it. | |
| party_address | No | New address. Cannot be set when the party's is_internal is true | |
| party_reference | No | New generic reference for the party | |
| party_identifier | Yes | ref_uuid, reference, or entity_name identifying the party to update on the document | |
| party_entity_name | No | New entity name. Cannot be set when the party's is_internal is true |
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 |