This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock

Create document from template

POST

https://api.signater.com/v1/ecm/documents/templates

Document

Last modified:2025-03-29 12:47:42

Creates a new document by applying a predefined template, which can be customized with specific data. The endpoint will return a unique document ID, which must be used for further operations such as signing or editing. If the document is not used within 24 hours, it will be automatically removed from the system's storage.

Request

Authorization

Add parameter in header

x-api-token

Example:

x-api-token: ********************

Body Params application/json

Request to create document from template

templateId

string <uuid>

required

Template ID

>= 1 characters

name

string | null

optional

Name of the file, to be used for the document, if not provided the file name will be used

<= 200 characters

privateDescription

string | null

optional

Private description of the file

<= 4000 characters

publicDescription

string | null

optional

Public description of the file

<= 4000 characters

language

enum<string> | enum<null>

optional

Language of the file, to be used in the markup if configured

Allowed values:

EnUsPtBr

markupOrientation

enum<string> | enum<null>

optional

Markup orientation of the file, it provides to all pages, information about the file and document, including a link to access the document publicly

Allowed values:

NoneBottomTopLeftRight

fields

array[object (CreateDocumentFromTemplateFieldApiRequest) {2}] | null

optional

Fields of the file

fieldId

string <uuid>

required

Field ID

>= 1 characters

value

string | null

optional

Value of the field

<= 4000 characters

Example

{
  "templateId": "99f42c60-af6d-4730-bc3b-1a7a81707129",
  "name": "Example file",
  "privateDescription": "Example private description",
  "publicDescription": "Example public description",
  "language": "EnUs",
  "markupOrientation": "Bottom",
  "fields": [
    {
      "fieldId": "43b16889-acce-49d1-87aa-81c4ac99f89a",
      "value": "Example field value"
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.signater.com/v1/ecm/documents/templates' \
--header 'Content-Type: application/json' \
--data-raw '{
    "templateId": "99f42c60-af6d-4730-bc3b-1a7a81707129",
    "name": "Example file",
    "privateDescription": "Example private description",
    "publicDescription": "Example public description",
    "language": "EnUs",
    "markupOrientation": "Bottom",
    "fields": [
        {
            "fieldId": "43b16889-acce-49d1-87aa-81c4ac99f89a",
            "value": "Example field value"
        }
    ]
}'

Responses

🟢201Created

application/json

Document created successfully

Body

string <uuid>

optional

Id of the created document

fileName

string | null

optional

Original file name

name

string | null

optional

Name

privateDescription

string | null

optional

Private description

publicDescription

string | null

optional

Public description

pageSizes

array[object (CreateDocumentFromTemplatePageSizeApiResponse) {3}] | null

optional

Page sizes

page

integer <int32>

optional

Page number, starting from 1

width

number <double>

optional

Width in pixels

height

number <double>

optional

Height in pixels

Example

{
  "id": "b07b4683-2b97-4918-b7e1-690924e914cc",
  "fileName": "FileName.pdf",
  "name": "Name",
  "privateDescription": "Private Description",
  "publicDescription": "Public Description",
  "pageSizes": [
    {
      "page": 1,
      "width": 100,
      "height": 200
    }
  ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-03-29 12:47:42

Upload document

Get document original file URL