Skip to main content
POST
/
v1
/
templates
Upload a Template
curl --request POST \
  --url https://reporter.sandbox.lerian.net/v1/templates \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-Organization-id: <x-organization-id>' \
  --form template='@example-file' \
  --form outputFormat=TXT \
  --form 'description=List of holders'
{
  "id": "0196b270-a315-7137-9408-3f16af2685e1",
  "outputFormat": "TXT",
  "description": "List of holders",
  "fileName": "0196b270-a315-7137-9408-3f16af2685e1.tpl",
  "createdAt": "2025-05-09T00:27:28.405080783Z"
}
Need a sample to test this endpoint? Click here to download a sample .tpl file.

Headers

​
Authorization
string

The authorization token in the 'Bearer ' format.
Important: This header is required if your environment has Access Manager enabled. For more information, refer to the Access Manager documentation.

​
Content-Type
string
required

The request content type. Important: For this endpoint, it must be multipart/form-data.

​
X-Organization-id
string
required

The unique identifier of the Organization associated with the request.

Body

multipart/form-data
​
template
file
required

The .tpl file you've created to serve as the template definition.

Example:

"@example-file"

​
outputFormat
enum<string>
required

The format of the report that the template will generate.

Available options:
HTML,
CSV,
XML,
PDF,
TXT
Example:

"TXT"

​
description
string
required

A brief description about the template.

Example:

"List of holders"

Response

Indicates that the resource was successfully created and the operation was completed as expected.

Details about the template that was created.

​
id
string

Unique ID that identifies the template (UUID format).

​
outputFormat
string

The format of the generated output (e.g., HTML, CSV, PDF, TXT, XML).

​
description
string

Briefly describes what the template is for or what it contains.

​
fileName
string

The name of the template file as stored in the system. Follows the <template_id>.tpl format.

​
createdAt
string

Timestamp indicating when the template was created.