Create a signing template

Creates a signing template from an uploaded Word file, or an empty one when no file is given. The template must be filed under a lease template category.

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Body

application/json

namestring

Name for the template, up to 250 characters.

templateTypeenum<string>required

What kind of document the template produces.

leaseleaseRenewallateRentNoticeevictionsignatureOnlyinformation

leaseTemplateCategoryIdstringrequired

The lease template category to file it under. A Snowflake id sent as a decimal string.

uploadSessionIdstring

Upload session holding the Word file to start from. Leave it out to create a template with no file yet.

Response

200 · The template that was created, with the URL of its Word file.

idstring

The signing template. A Snowflake id sent as a decimal string.

companyIdstring

The company the template belongs to.

documentIdstring

The underlying document record that holds the Word file and its placeholders.

namestring

Name of the template. Absent when none was given.

templateTypeenum<string>

What kind of document the template produces.

leaseleaseRenewallateRentNoticeevictionsignatureOnlyinformation

leaseTemplateCategoryIdstring

The category the template is filed under. Absent when it is uncategorised.

docxUrlstring

URL of the current Word file, for opening in the document editor.

createdstring · date-time

When the template was created, in the company's timezone.

updatedstring · date-time

When it was last changed, in the company's timezone.

401 · The access token is missing, expired, or not valid for this company.

To start from a Word file, request an upload session first, send the bytes to it, then pass the session id here.