Developer

POST Template Create API

This API will allow the user to create the personalized templates.

Request Attributes

API Content Type: JSON

Head

ATTRIBUTE	DESCRIPTION
x-access-token string mandatory	Token generated from the authentication api. Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.TU5NzgyMDA1N30.9eO_xh eyJEYXRhIjp7InVzZXJpZCI6IjY3NCIsImVtYWlsIjoiYWFhYWFhYWFhYWjuunGJQ YmwuY29tIiwia2V5IjoidGVzdGluZ0tleSJ9LCJpYXQiOjE1OTc3NDA4NTpj6gc8dM csIFhY7n1mV4cUBxa2P3ICI6M2VyWq19OzuHAefeTEj

body

ATTRIBUTE

DESCRIPTION

user_id

string(32)

mandatory

UserId given in companyprofile page.

Example: USR1HINU6OROEZZP1YS1592227436777

template_name

string(32)

mandatory

Name of the template.

Example: HR Policy

template_keywords

string(32)

mandatory

Keywords for the template.

Example: HR Policy 2020

template_category

string(32)

mandatory

Category of the template.

Example: Managers

description

string(150)

mandatory

Description of the template.

Example: HR Policy for Employees

template_documents

array of object

mandatory

An Array of multiple files.

Attribute	Description
name string(32) mandatory	Name of the file. Example: HR Policy
fileExtension string(10) mandatory	Extention of the file. Example: .pdf
documentBase64 string(max) mandatory	Bas64 of the file. Example: iVBORw0KGgoAAAANSUhEUgAAAhEAAADrCAYAAADXCMREAAAAAXNSR0 IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAACRbSU RBVHhe7d2/jxVXmvBx/ogNHU0yzvgHJsUjOZrVJh5PNCQ7ckTCbmCRIDQSiRkLTdDewF qpJcZohBxZGI0IrFf82Alsy/tiIxosm25s3oaGRqM2q3791qtv3fu0nz6uqlv30Fxo+H6ko7p1 6pxTp4rgee6p29SBR

template_role

array of object

mandatory

This parameter is an array of object and should contain the details of roles i.e. role and type.

Attribute	Description
role string(32) mandatory	Role of the recipient. Example: Manager
type string(32) mandatory	Type of the role. Possible Values: Need to sign or Send a copy

signingorder

string(1)

mandatory

Signing order of the roles can be set.

Possible Values: 0 or 1

predefiendfields

array of object

optional

This parameter is an array of object and should contain the details of predefiendfields i.e. field and childfield.

Possible Values: 0 or 1

ipaddress

string(32)

optional

Ip address of the system.

Example: 172.16.254.1

browser

string(32)

optional

Browser name.

Example: Chrome

string(32)

optional

Operating System name.

Example: Microsoft Windows

country

string(32)

optional

Country name.

Example: India

Response Attributes

API Content Type: JSON

body

ATTRIBUTE

DESCRIPTION

statuscode

string(3)

This is the status code corresponding to a particular message and is returned to the user. The different status codes corresponding to this API are mentioned below

Example: 200

status

boolean

This parameter indicates the status of API call.

Possible Values: true or false

data

object

This parameter gives the information about the result of the API response.

Attribute	Description
session_id string(32)	Session Id of the template. Example: ec8384487f387cb1c1eadeade0804552:4a4666536fa58c176ec579978150776438cf 694e6127a44181f3c336fbc9b4438cf694e6127a44d352de0a10c2ca7d03c336fb79b44d352de 0a1033ea2050e67c47e
template_id string(32)	Unique Id of the template. Example: 8JIA11252061081EUW6MK20207933692

message

string(100)

This parameter is the result message which contains information about the result.

Example: template created successfully.

Response Codes and Messages

statuscode	status	Description
200	true	Success
401	false	Your Session has expired
409	false	Conflict has occured
422	false	Invalid parameter
500	false	System error