Create document party
create-document-partyAdds a party to a document, alongside any parties it already has.
Use this tool when:
A contracting party is missing from a document, e.g. the counterparty of a contract created from scratch
A signatory has to be added for a party the document does not have yet: create the party first, then add the signatory with create-document-signatory
Pass party_account_party_uuid to add one of the account's saved parties (list-account-parties), usually the user's own company. A saved party can be on a document only once, and is always internal. For any other party, give party_entity_name, party_address and party_scope instead.
Parties cannot be added while the document is archived, in the signing stage or an approved stage, going through an approval checkpoint, or bound by a preemptive signature.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"document_uuid": "<document_uuid>",
"party_reference": "<party_reference>"
},
"name": "create-document-party"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| party_scope | No | When this is internal_and_external, collaborators from this party may change the party's information. Required when party_account_party_uuid is not sent | |
| document_uuid | Yes | UUID of the document to add the party to. If you don't already have the document's UUID, use the list-documents tool to find it. | |
| party_address | No | Party's address. Cannot be sent alongside party_account_party_uuid | |
| party_reference | Yes | Generic reference for the party. e.g. "Counterparty", "Customer", "Employee", etc | |
| party_entity_name | No | Actual name of the party. Cannot be sent alongside party_account_party_uuid | |
| party_account_party_uuid | No | To add a saved account party, the uuid of a party from the list-account-parties tool |
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 |