Document Resources API

Endpoint Index

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

¶

fetchDocumentResourceByName

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
name	path	string	required
byStaticName	query	boolean?	optional
date	query	datetime?	optional

Response:StreamingResponseBody<string>

Security Group:documents Permission:read

Create a New Document Resource

¶

createDocumentResource

POST /resource/{tenantLocator}/documents

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
Content-Type	header	string	required
name	query	string	required
staticName	query	string	required

Request:file

Response:BasicResourceResponse

Security Group:documents Permission:upload

Update a Document Resource

¶

updateDocument

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
Content-Type	header	string	required
name	path	string	required

Request:file

Response:BasicResourceResponse

Security Group:documents Permission:update

Document Templates

Fetch a Template

¶

fetchDocumentTemplate

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
name	path	string	required
byStaticName	query	boolean?	optional
date	query	datetime?	optional

Response:StreamingResponseBody<string>

Security Group:templates Permission:read

Upload a Velocity Template

¶

createVelocityDocumentTemplate

POST /resource/{tenantLocator}/templates/velocity

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
name	query	string	required
staticName	query	string	required

Request with text/plain:TemplateResponse

Request with multipart/form-data:TemplateResponse

Response:BasicResourceResponse

Security Group:templates Permission:upload

Update a Velocity Template

¶

updateVelocityDocumentTemplate

PATCH /resource/{tenantLocator}/templates/velocity

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
name	query	string	required

Request with text/plain:TemplateResponse

Request with multipart/form-data:TemplateResponse

Response:BasicResourceResponse

Security Group:templates Permission:upload

Upload a Liquid Template

¶

createLiquidDocumentTemplate

POST /resource/{tenantLocator}/templates/liquid

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
name	query	string	required
staticName	query	string	required

Request with text/plain:TemplateResponse

Request with multipart/form-data:TemplateResponse

Response:BasicResourceResponse

Security Group:templates Permission:upload

Update a Liquid Template

¶

updateLiquidDocumentTemplate

PATCH /resource/{tenantLocator}/templates/liquid

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
name	query	string	required

Request with text/plain:TemplateResponse

Request with multipart/form-data:TemplateResponse

Response:BasicResourceResponse

Security Group:templates Permission:upload

Note

Document templates are limited to 5MB in size.

StreamingResponseBody

¶

no fields

Document Snippets

Fetch a Template Snippet

¶

fetchTemplate

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
name	path	string	required
byStaticName	query	boolean?	optional
date	query	datetime?	optional

Response:StreamingResponseBody<string>

Security Group:templates Permission:read

Upload a Velocity Template Snippet

¶

uploadVelocity

POST /resource/{tenantLocator}/templateSnippets/velocity

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
name	query	string	required
staticName	query	string	required

Request with text/plain:TemplateResponse

Request with multipart/form-data:TemplateResponse

Response:BasicResourceResponse

Security Group:templates Permission:upload

Update a Velocity Template Snippet

¶

updateVelocity

PATCH /resource/{tenantLocator}/templateSnippets/velocity

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
name	query	string	required

Request with text/plain:TemplateResponse

Request with multipart/form-data:TemplateResponse

Response:BasicResourceResponse

Security Group:templates Permission:upload

Upload a Liquid Template Snippet

¶

uploadLiquid

POST /resource/{tenantLocator}/templateSnippets/liquid

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
name	query	string	required
staticName	query	string	required

Request with text/plain:TemplateResponse

Request with multipart/form-data:TemplateResponse

Response:BasicResourceResponse

Security Group:templates Permission:upload

Update a Liquid Template Snippet

¶

updateLiquid

PATCH /resource/{tenantLocator}/templateSnippets/liquid

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
name	query	string	required

Request with text/plain:TemplateResponse

Request with multipart/form-data:TemplateResponse

Response:BasicResourceResponse

Security Group:templates Permission:upload

Custom Fonts

Add a custom font

¶

addFont

POST /resource/{tenantLocator}/fonts

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
name	query	string	required
staticName	query	string	required

Request:file

Response:BasicResourceResponse

Security Group:fonts Permission:upload