Document Resources API

Action	Endpoint
Fetch a Document Resource by Name	GET/resource/{tenantLocator}/documents/{name}
Create a New Document Resource	POST/resource/{tenantLocator}/documents
Update a Document Resource	PATCH/resource/{tenantLocator}/documents/{name}
Fetch a Template	GET/resource/{tenantLocator}/templates/{name}
Upload a Velocity Template	POST/resource/{tenantLocator}/templates/velocity
Update a Velocity Template	PATCH/resource/{tenantLocator}/templates/velocity
Upload a Liquid Template	POST/resource/{tenantLocator}/templates/liquid
Update a Liquid Template	PATCH/resource/{tenantLocator}/templates/liquid
Fetch a Template Snippet	GET/resource/{tenantLocator}/templateSnippets/{name}
Upload a Velocity Template Snippet	POST/resource/{tenantLocator}/templateSnippets/velocity
Update a Velocity Template Snippet	PATCH/resource/{tenantLocator}/templateSnippets/velocity
Upload a Liquid Template Snippet	POST/resource/{tenantLocator}/templateSnippets/liquid
Update a Liquid Template Snippet	PATCH/resource/{tenantLocator}/templateSnippets/liquid
Add a custom font	POST/resource/{tenantLocator}/fonts

Document Resources

Fetch a Document Resource by Name

Fetch a Document Resource by NamefetchDocumentResourceByName

GET/resource/{tenantLocator}/documents/{name}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`name`	path	`string`	Yes
`byStaticName`	query	`boolean?`	No
`date`	query	`datetime?`	No
`jurisdiction`	query	`string?`	No

Response:StreamingResponseBody<string>

Security Group:documents

Permission:

read

Create a New Document Resource

Create a New Document ResourcecreateDocumentResource

POST/resource/{tenantLocator}/documents

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`Content-Type`	header	`string`	Yes
`name`	query	`string`	Yes
`staticName`	query	`string`	Yes
`jurisdiction`	query	`string[]?`	No

Request:file

Response:BasicResourceResponse

Security Group:documents

Permission:

upload

Update a Document Resource

Update a Document ResourceupdateDocument

PATCH/resource/{tenantLocator}/documents/{name}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`Content-Type`	header	`string`	Yes
`name`	path	`string`	Yes

Request:file

Response:BasicResourceResponse

Security Group:documents

Permission:

update

Document Templates

Fetch a Template

Fetch a TemplatefetchDocumentTemplate

GET/resource/{tenantLocator}/templates/{name}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`name`	path	`string`	Yes
`byStaticName`	query	`boolean?`	No
`date`	query	`datetime?`	No
`jurisdiction`	query	`string?`	No

Response:StreamingResponseBody<string>

Security Group:templates

Permission:

read

Upload a Velocity Template

Upload a Velocity TemplatecreateVelocityDocumentTemplate

POST/resource/{tenantLocator}/templates/velocity

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`name`	query	`string`	Yes
`staticName`	query	`string`	Yes
`jurisdiction`	query	`string[]?`	No

Request with text/plain:TemplateResponse

Request with multipart/form-data:TemplateResponse

Response:BasicResourceResponse

Security Group:templates

Permission:

upload

Update a Velocity Template

Update a Velocity TemplateupdateVelocityDocumentTemplate

PATCH/resource/{tenantLocator}/templates/velocity

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`name`	query	`string`	Yes

Request with text/plain:TemplateResponse

Request with multipart/form-data:TemplateResponse

Response:BasicResourceResponse

Security Group:templates

Permission:

upload

Upload a Liquid Template

Upload a Liquid TemplatecreateLiquidDocumentTemplate

POST/resource/{tenantLocator}/templates/liquid

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`name`	query	`string`	Yes
`staticName`	query	`string`	Yes
`jurisdiction`	query	`string[]?`	No

Request with text/plain:TemplateResponse

Request with multipart/form-data:TemplateResponse

Response:BasicResourceResponse

Security Group:templates

Permission:

upload

Update a Liquid Template

Update a Liquid TemplateupdateLiquidDocumentTemplate

PATCH/resource/{tenantLocator}/templates/liquid

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`name`	query	`string`	Yes

Request with text/plain:TemplateResponse

Request with multipart/form-data:TemplateResponse

Response:BasicResourceResponse

Security Group:templates

Permission:

upload

Document templates are limited to 5MB in size.

StreamingResponseBody

No properties defined.

Document Snippets

Fetch a Template Snippet

Fetch a Template SnippetfetchTemplate

GET/resource/{tenantLocator}/templateSnippets/{name}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`name`	path	`string`	Yes
`byStaticName`	query	`boolean?`	No
`date`	query	`datetime?`	No
`jurisdiction`	query	`string?`	No

Response:StreamingResponseBody<string>

Security Group:templates

Permission:

read

Upload a Velocity Template Snippet

Upload a Velocity Template SnippetuploadVelocity

POST/resource/{tenantLocator}/templateSnippets/velocity

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`name`	query	`string`	Yes
`staticName`	query	`string`	Yes
`jurisdiction`	query	`string[]?`	No

Request with text/plain:TemplateResponse

Request with multipart/form-data:TemplateResponse

Response:BasicResourceResponse

Security Group:templates

Permission:

upload

Update a Velocity Template Snippet

Update a Velocity Template SnippetupdateVelocity

PATCH/resource/{tenantLocator}/templateSnippets/velocity

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`name`	query	`string`	Yes

Request with text/plain:TemplateResponse

Request with multipart/form-data:TemplateResponse

Response:BasicResourceResponse

Security Group:templates

Permission:

upload

Upload a Liquid Template Snippet

Upload a Liquid Template SnippetuploadLiquid

POST/resource/{tenantLocator}/templateSnippets/liquid

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`name`	query	`string`	Yes
`staticName`	query	`string`	Yes
`jurisdiction`	query	`string[]?`	No

Request with text/plain:TemplateResponse

Request with multipart/form-data:TemplateResponse

Response:BasicResourceResponse

Security Group:templates

Permission:

upload

Update a Liquid Template Snippet

Update a Liquid Template SnippetupdateLiquid

PATCH/resource/{tenantLocator}/templateSnippets/liquid

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`name`	query	`string`	Yes

Request with text/plain:TemplateResponse

Request with multipart/form-data:TemplateResponse

Response:BasicResourceResponse

Security Group:templates

Permission:

upload

Custom Fonts

Add a custom font

Add a custom fontaddFont

POST/resource/{tenantLocator}/fonts

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`name`	query	`string`	Yes
`staticName`	query	`string`	Yes
`jurisdiction`	query	`string[]?`	No

Request:file

Response:BasicResourceResponse

Security Group:fonts

Permission:

upload

- Documents API - Documents Configuration Guide

Document Resources API

On this page