Create Template

POST 
/createtemplate

The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique template_id that can be used to generate documents based on the specified template.

Upload you pdf in our Debug UI here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF.

Below widgets are supported in the document:

Common parameters of widgets:

• type: Indicates the type of widget.
• page: Specifies the page number on which you want to place the respective widget.
• x, y: Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values.
• w, h: Represents the width and height of the widget. You can adjust these values using the debug UI.
• required: Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets.
• name: Provides a different name for widgets if you are providing more than one widget.

1. signature:

{
  "type":"signature", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21
}

2. stamp:

{
  "type":"stamp", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21, 
  "options": {
    "required": true, 
    "name": "stamp"
  }
}

3. initials:

{
  "type":"initials", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21, 
  "options": {
    "required": true, 
    "name": "initials"
  }
}

4. email:

{
  "type":"email", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21, 
  "options": {
    "required": true, 
    "name": "email"
  }
}

5. name:

{
  "type":"name", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21, 
  "options": {
    "required": true, 
    "name": "name"
  }
}

6. job title:

{
  "type":"job title", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21, 
  "options": {
    "required": true, 
    "name": "job title"
  }
}

7. company:

{
  "type":"company", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21, 
  "options": {
    "required": true, 
    "name": "company"
  }
}

8. date:

{
  "type":"date", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21, 
  "options": {
    "required": true, 
    "name": "date",
    "default": "04-15-2024",
    "format": "mm-dd-yyyy" 
  }
}

• default: Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided.
• format: Specify the date format of your choice from the options below.
  • "dd/MM/yyyy",
  • "dd-mm-yyyy",
  • "yyyy-mm-dd",
  • "mm.dd.yyyy",
  • "mm-dd-yyyy",
  • "mmm dd, yyyy",
  • "mmmm dd, yyyy",
  • "dd mmm, yyyy",
  • "dd mmmm, yyy"

9. textbox:

{
  "type":"textbox", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21, 
  "options": {
    "required": true, 
    "name": "textbox",
    "default": "name",
    "hint": "provide name",
    "regularexpression":""
  }
}

• default: Provide a default value for the textbox (Optional).
• hint: Provide a hint for the textbox (Optional).
• regularexpression: Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional).

10. checkbox:

{
  "type":"checkbox", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21, 
  "options": {
    "required": true, 
    "name": "checkbox",
    "values": ["male", "female", "other"],
    "selectedvalues": [ "male", "female" ],
    "readonly": false, 
    "hidelabel": false,
    "validation": {
      "minselections": 0, 
      "maxselections": 0 
    }
  }
}

• values: Provide options for the checkbox list.
• selectedvalues: Provide values that need to be selected by default (Optional).
• readonly: Set to true if you want to set the checkbox as readonly. By default, it's false
• hidelabel: Set to true if you want to hide labels of the checkbox. By default, it's false.
• minselections: Provide the minimum number of checkboxes that must be selected by the user.
• maxselections: Provide the maximum number of checkboxes that can be selected by the user.

11. dropdown:

{
 "type":"dropdown", 
 "page":1,  
 "x": 327, 
 "y": 628, 
 "w": 114, 
 "h": 21, 
 "options": {
   "required": true, 
   "name": "dropdown",
   "values": ["male", "female", "other"],
   "default": "male"
   }
 }
}

• values: Provide options for the dropdown list.
• default: Provide the value that needs to be selected by default. Only one value is accepted. (Optional).

12. radio button:

{
  "type":"radio button", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21, 
  "options": {
    "required": true, 
    "name": "radio button",
    "values": ["male", "female", "other"],
    "default": "male"
    }
  }
}

• values: Provide options for the radio button list.
• default: Provide the value that needs to be selected by default. Only one value is accepted. (Optional).

13. image:

{
  "type":"image", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21, 
  "options": {
    "required": true, 
    "name": "image"
    }
  }
}

Request

application/json

Body

required

file base64required
title stringrequired
note string
description string

signers

object[]

required

You can provide signer optionally if you it as default signer

Array [

role string

email string

name string

phone string

widgets

object[]

Array [

type string

Allowed values - signature, stamp.

page number

The page number on which the widget should appear. use our Debug UI to calculate the value.

x number

x co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

y number

y co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

w number

Width of widget. use our Debug UI to calculate the value.

h number

Height of widget. use our Debug UI to calculate the value.

]

]

sendInOrder boolean

Responses

200

Template created successfully!

application/json

Schema

Schema

objectId string
message string

Example (from schema)

{
  "objectId": "Bh2Hspnmch",
  "message": "Template created successfully!"
}

400

Something went wrong, please try again later!

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Something went wrong, please try again later!"
}

405

Invalid API Token!

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Invalid API token!"
}

Loading...