Templates API
Last updated
Last updated
Below APIs are deprecated and new version of APIs are available at https://dashboard.docupilot.app/api-docs/swagger-ui/
GET
https://api.docupilot.app/api/v1/templates
This endpoint allows you to get templates in home folder. You can add filter or folder query params for more desired results.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
GET
https://api.docupilot.app/api/v1/templates/:id
This endpoint allows you to get details of each template.
POST
https://api.docupilot.app/api/v1/templates
This endpoint allows you to create a new template.
PUT
https://api.docupilot.app/api/v1/templates/:id
This endpoint allows you to update a template
DELETE
https://api.docupilot.app/api/v1/templates/:id
The template will be moved to Trash and will be deleted permanently after 30 days
POST
https://api.docupilot.app/api/v1/templates/:id/content
This end point allows you to add or update template content.
GET
https://api.docupilot.app/api/v1/templates/:id/schema
This endpoint allows you to get token details of the template.
POST
https://api.docupilot.app/api/v1/templates/:id/merge
This endpoint allows you to create a new document from a template.
The body parameters for Merge API depends on the tokens configured in the document.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
folder
number
Folder ID
filter
string
Possible Values are all | trash
apikey
string
API Key
id
integer
Template ID
apikey
string
API Key
Content-Type
string
application/json
apikey
string
API Key
output_file_name
string
File name for the generated document. Example : Certificate - {{name}}
folder
string
Folder ID
document_status
string
Allowed values test | active. Default : test
description
string
Description for the template
type
string
Allowed values html | docx | pptx | xlsx | fillable_pdf Default : html
title
string
Title for the template
apikey
string
API Key
Content-Type
string
application/json
title
string
Title for the template
description
string
Description for the template
document_status
string
Allowed values test | active
folder
string
Folder ID
output_file_name
string
File name for the generated document. Example : Certificate - {{name}}
id*
String
Template ID
apikey*
String
API Key
id
string
Template ID
apikey
string
API Key
file
object
DOCX, PPTX, XlSX, Fillable_PDF file
id
integer
Template ID
apikey
string
API Key
id
string
Template ID
Content-Type
string
application/json
apikey
string
API Key
user_email
string
John@example.com
name
string
John