Create template party
create-template-partyAdd a party to a template.
Use this tool when:
The user wants to add a party (e.g. a counterparty, customer, or employer) to a template
You are building up a template and need parties before adding signatories or signature blocks
There are two ways to add a party:
Internal (saved) party: send
account_party_uuid(from list-account-parties) together withreference. No other fields may be sent in this case.External party: send
referenceandscope, and optionallyentity_nameandaddress.
The two names on a party say different things:
referenceis the generic label for the party's role on the template (e.g. "Employer", "Customer"), and stays the same for every document made from it.entity_nameis the name of the legal entity itself: a company's name ("Acme GmbH") or, when the party is an individual rather than an organisation, that person's name. On a template it is usually only known for the account's own side; a counterparty's is filled in per document, so leave it out rather than inventing one.
To render the party's details inline in the template text, reference the returned ref_uuid in the body
(via replace-template-content) as:
<span data-party data-ref-uuid="<party ref_uuid>" data-format="name"></span>where data-format selects what is rendered: "name" (the party's entity/company name), "reference" (its
reference label), "address", or "address:inline". A data-format is required.
Note: adding a party does not, by itself, give that party anywhere to sign. If the party is meant to sign documents
created from the template, follow up with create-template-signature-block for the party — and remember that the
signature block must in turn be placed in the template content (via replace-template-content) inside a signature
container, <div data-signatures><span data-signature-block data-ref-uuid="..."></span></div>, before it will appear on any
document.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scope | No | When internal_and_external, collaborators from this party may change the party's information. Required when account_party_uuid is not sent. | |
| address | No | Party's address. Cannot be sent alongside account_party_uuid | |
| reference | Yes | Generic reference for the party's role on the template. e.g. "Counterparty", "Customer", "Employer" | |
| entity_name | No | Name of the legal entity that is party to the contract - a company's name, or a person's name when the party is an individual. Cannot be sent alongside account_party_uuid | |
| template_uuid | Yes | UUID of the template to add the party to | |
| account_party_uuid | No | To add a saved account party, the uuid of a party from the list-account-parties tool. When provided, only reference may accompany it. |
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 |