Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-24122271451.2 KB
Templates

Create Template

This operation allows you to create a new template by providing the necessary template details.

post/public/v1/templates

Query parameters

fieldsstring[]

A comma-separated list of additional fields to include in the response.

Request body

urlstring

Secure (HTTPS) and publicly accessible URL to the PDF document.

namestring

The name of the template.

folder_uuidstring

The ID of the folder where the created template should be stored.

metadataobject nullable

You can pass arbitrary data in the key-value format to associate custom information with a template. This information is returned in any API requests for the template details by id.

Example request

{
  "url": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
  "name": "Template name example",
  "folder_uuid": "EE8yUNg5HztqVAuH85He8V",
  "owner": {
    "membership_id": "QMDSzwabfFzTgjW6KijHyu",
    "email": "john.doe@example.com"
  },
  "metadata": {
    "my_favorite_pet": "Panda"
  },
  "tokens": [
    {
      "name": "Favorite.Pet",
      "value": "Panda"
    }
  ]
}

Response

OK

idstring
namestring
date_createdstring date-time
date_modifiedstring date-time
versionstring
content_date_modifiedstring date-time

Example response

{
  "id": "iMymdDd9XFD3HyxP5VD67Q",
  "name": "Blank",
  "date_created": "2021-06-17T15:51:13.226974Z",
  "date_modified": "2021-06-17T15:51:13.326974Z",
  "version": "2",
  "content_date_modified": "2021-06-17T15:51:13.426974Z"
}