POST Send Template API

This API will allow the user to send the template.

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_id
string(32)
mandatory
Unique Id of the template.
Example: 8JIA11252061081EUW6MK20207933692
array of object
mandatory
This parameter is an array of object and should contain the details of recipients i.e. role, name and Email.
Attribute Description
role
string(32)
mandatory
Role of the recipient.
Example: Manager
name
string(32)
mandatory
Name of the recipient.
Example: Sachin
Email
string(32)
mandatory
Email of the recipient.
Example: sachin@gmail.com
object
optional
This parameter is an object and should contain the value of group i.e. role, Id and GroupName.
Attribute Description
role
string(32)
mandatory
Role of the recipient.
Example: Manager
Id
string(32)
mandatory
Unique Id of that particular group.
Example: 125
GroupName
string(32)
mandatory
Name of the group.
Example: Employees
predefiendfield
array of object
optional
This parameter is an array of object and should contain the details of predefiendfield i.e. role, predefinedEmail and predefiendfield.
Possible Values: 0 or 1
subject
string(32)
mandatory
Subject name of the email template.
Example: KonsignCase
message
string(32)
optional
Message can be conveyed to the recipients via the Email template.
Example: Please sign teh document.
allowDelegation
boolean
optional
This parameter will allow recipients to delegate the document.
Possible Values: true or false
allowapplysignAll
boolean
optional
This parameter will allow recipients to apply sign all at once in the document.
Possible Values: true or false
allowkonsignlogoinsign
boolean
optional
This parameter will include konsign logo in the signature.
Possible Values: true or false
allowsignaftergroupdecline
boolean
optional
This parameter will allow other group recipients to complete the document even after some of them have declined the document.
Possible Values: true or false
expirationdate
string(10)
mandatory
This parameter will assign expiry date to the document.
Possible Values: 2020-12-03
reminderBeforeExpiration
string(2)
optional
This parameter will remind recipients to sign the document before specified days of the expiry date.
Example: 2
reminders
string(10)
optional
This parameter will allow to set reminders for the document.
Possible Values: daily, weeekly or custom
object
optional
This parameter will required when reminders is set to custom. This parameter is an object and should contain the value of custom reminders i.e. beforefirstreminder and daysbetweenreminder.
Attribute Description
beforefirstreminder
string(32)
mandatory
Number of days before sending first reminder of the expiring date of the document.
Example: 20
daysbetweenreminder
string(32)
mandatory
Number of days between reminder.
Example: 5
ipaddress
string(32)
optional
Ip address of the system.
Example: 172.16.254.1
browser
string(32)
optional
Browser name.
Example: Chrome
os
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
object
This parameter gives the information about the result of the API response.
Attribute Description
companyid
string(32)
Unique Id of the company.
Example: A11252061088JI1EUW6MK20207933692
userid
string(32)
Unique Id of the user.
Example: W6MK20207938JIA11252061081EU3692
document_id
string(32)
Unique Id of the document.
Example: 8JIA11252061081EUW6MK20207933692
templateid
string(32)
Unique Id of the template.
Example: MK202079338JIA11252061081EUW6692
message
string(100)
This parameter is the result message which contains information about the result.
Example: mail send 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
https://console.konsign.com/api/template/sendtemplate
https://console.konsign.com/api/template/sendtemplate
REQUEST RESPONSE 

											var request = require('request');
											var options = {
											'method': 'POST',
											'url': 'https://console.konsign.com/api/template/sendtemplate',
											'headers': {
												'Content-Type': 'application/json',
												'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7InVzZXJpZCI6IjQ4OSIsImVtYWlsIjoiZGlyZWN0b3JAYXVzc2l6emdyb3VwLmNvbSIsImtleSI6InByb2R1Y3Rpb25LZXkifSwiaWF0IjoxNjc3MTMyMTk5LCJleHAiOjE2NzcyMTEzOTl9.0z3_Qm_fIShmsJo7Klus8GaMypga-Aa7xZ6XEhsipXM',
												'Cookie': 'session=eyJVc2VyX0lkIjoiNTQ2IiwiVXNlcl9FbWFpbCI6ImhpdGVzaC5qb3NoaUBrb256ZS5jb20ifQ==; session.sig=wm5vA4CRl6Lk5_adFmanudPrWkc'
											},
											body: JSON.stringify({
												"authorization_id": "fMerWV8NU98KTuonc27xB+HfCki9v9+whagcF5NLfqJEyR0X8kDLZnyPU1gSQKPi",
												"client_id": "YjAxMDY0YWQtMDIxNi00ZmNlLThkNDMtODI0MjAyMjA3MjAyOA==",
												"user_id": "USRDXV4ZZRG9C03C3HI1630970419495",
												"template_id": "TMPB8WKLCS73RNEHMF51675257596204",
												"subject": "Electronic Sign (E-Sign) Your 956",
												"message": "Hey Yogesh Sonavane,
 Yogesh SonavanefromTester Testing Company Demohas sent you the 956.In order to accept this 956 please view and e-sign the document by clicking on the button below.",
												"allowDelegation": true,
												"allowapplysignAll": true,
												"allowkonsignlogoinsign": false,
												"expirationdate": "2023-03-31",
												"reminders": "daily",
												"reminderBeforeExpiration": "1",
												"recipient": [
												{
													"role": "client",
													"name": "Yogesh Sonavane",
													"Email": "yogesh.sonavane@konze.com"
												},
												{
													"role": "agent",
													"name": "Govyanshi Upadhyay",
													"Email": "govyanshi.upadhyay@konze.com"
												}
												],
												"predefiendfield": [
												{
													"role": "client",
													"predefinedEmail": "yogesh.sonavane@konze.com",
													"predefiendfield": [
													{
														"chk_newappoinment_1": [
														true
														],
														"chk_mrs_2": [
														true
														],
														"txt_familyname_2": "Keval",
														"txt_givenname_2": "Pandya",
														"txt_exemptpersondob_2": "09/11/2022",
														"txt_organisationnameline1_3": "Tester Testing Company Demo",
														"txt_businorresidadd1_4": "101-Himalya Mall",
														"txt_businorresidadd2_4": "Near SBI Bank MELBOURNE",
														"txt_businorresidadd3_4": "VICTORIA AUSTRALIA",
														"txt_postcode_4": "222222",
														"txt_correspondadd1_5": "AS ABOVE",
														"txt_mobile_6": "9876543210",
														"chk_yes_7": [
														true
														],
														"txt_emailadd_7": "keval.pandya@konze.com",
														"chk_exemptperson_8": [
														true
														],
														"chk_yes_10": [
														true
														],
														"chk_visaapplicant_12": [
														true
														],
														"txt_familyname_13": "Yogesh",
														"txt_givenname_13": "Sonavane",
														"txt_dob_13": "23/11/2022",
														"txt_businorresidadd1_13": "TEST",
														"txt_businorresidadd3_13": "GUJARAT",
														"txt_postcode_13": "321654",
														"txt_mobile_13": "+919687747417",
														"chk_appprocess_15": [
														true
														],
														"txt_typeofapp_15": "TEZT",
														"chk_notyetlodged_15": [
														true
														],
														"chk_yes_17": [
														true
														],
														"chk1_legalpractitioner_23": [
														true
														],
														"chk1_legalpractitioner_24": [
														true
														]
													}
													]
												}
												],
												"udp": "{\"konsigndocumentid\":null,\"konsigndocumentbase64\":null,\"filename\":\"956\",\"applicantidf\":\"227242\",\"processidf\":\"36\",\"signdocumentid\":\"1\",\"requestid\":\"170843\",\"senduserid\":\"265448\",\"pdfid\":\"0\",\"leadassignedidf\":\"768679\",\"serviceid\":\"690\",\"companyid\":\"11412\",\"branchid\":\"0\",\"DocType\":\"956\"}"
											})

											};
											request(options, function (error, response) {
											if (error) throw new Error(error);
											console.log(response.body);
											});


										
									

											var client = new HttpClient();
											var request = new HttpRequestMessage(HttpMethod.Post, "https://console.konsign.com/api/template/sendtemplate");
											request.Headers.Add("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7InVzZXJpZCI6IjQ4OSIsImVtYWlsIjoiZGlyZWN0b3JAYXVzc2l6emdyb3VwLmNvbSIsImtleSI6InByb2R1Y3Rpb25LZXkifSwiaWF0IjoxNjc3MTMyMTk5LCJleHAiOjE2NzcyMTEzOTl9.0z3_Qm_fIShmsJo7Klus8GaMypga-Aa7xZ6XEhsipXM");
											request.Headers.Add("Cookie", "session=eyJVc2VyX0lkIjoiNTQ2IiwiVXNlcl9FbWFpbCI6ImhpdGVzaC5qb3NoaUBrb256ZS5jb20ifQ==; session.sig=wm5vA4CRl6Lk5_adFmanudPrWkc");
											var content = new StringContent("{\r\n    \"authorization_id\": \"fMerWV8NU98KTuonc27xB+HfCki9v9+whagcF5NLfqJEyR0X8kDLZnyPU1gSQKPi\",\r\n    \"client_id\": \"YjAxMDY0YWQtMDIxNi00ZmNlLThkNDMtODI0MjAyMjA3MjAyOA==\",\r\n    \"user_id\": \"USRDXV4ZZRG9C03C3HI1630970419495\",\r\n    \"template_id\": \"TMPB8WKLCS73RNEHMF51675257596204\",\r\n    \"subject\": \"Electronic Sign (E-Sign) Your 956\",\r\n    \"message\": \"Hey Yogesh Sonavane,
 Yogesh Sonavane from Tester Testing Company Demo has sent you the 956. In order to accept this 956 please view and e-sign the document by clicking on the button below.\",\r\n    \"allowDelegation\": true,\r\n    \"allowapplysignAll\": true,\r\n    \"allowkonsignlogoinsign\": false,\r\n    \"expirationdate\": \"2023-03-31\",\r\n    \"reminders\": \"daily\",\r\n    \"reminderBeforeExpiration\": \"1\",\r\n    \"recipient\": [\r\n        {\r\n            \"role\": \"client\",\r\n            \"name\": \"Yogesh Sonavane\",\r\n            \"Email\": \"yogesh.sonavane@konze.com\"\r\n        },\r\n        {\r\n            \"role\": \"agent\",\r\n            \"name\": \"Govyanshi Upadhyay\",\r\n            \"Email\": \"govyanshi.upadhyay@konze.com\"\r\n        }\r\n    ],\r\n    \"predefiendfield\": [\r\n        {\r\n            \"role\": \"client\",\r\n            \"predefinedEmail\": \"yogesh.sonavane@konze.com\",\r\n            \"predefiendfield\": [\r\n                {\r\n                    \"chk_newappoinment_1\": [\r\n                        true\r\n                    ],\r\n                    \"chk_mrs_2\": [\r\n                        true\r\n                    ],\r\n                    \"txt_familyname_2\": \"Keval\",\r\n                    \"txt_givenname_2\": \"Pandya\",\r\n                    \"txt_exemptpersondob_2\": \"09/11/2022\",\r\n                    \"txt_organisationnameline1_3\": \"Tester Testing Company Demo\",\r\n                    \"txt_businorresidadd1_4\": \"101 - Himalya Mall\",\r\n                    \"txt_businorresidadd2_4\": \"Near SBI Bank    MELBOURNE\",\r\n                    \"txt_businorresidadd3_4\": \"VICTORIA    AUSTRALIA\",\r\n                    \"txt_postcode_4\": \"222222\",\r\n                    \"txt_correspondadd1_5\": \"AS ABOVE\",\r\n                    \"txt_mobile_6\": \"9876543210\",\r\n                    \"chk_yes_7\": [\r\n                        true\r\n                    ],\r\n                    \"txt_emailadd_7\": \"keval.pandya@konze.com\",\r\n                    \"chk_exemptperson_8\": [\r\n                        true\r\n                    ],\r\n                    \"chk_yes_10\": [\r\n                        true\r\n                    ],\r\n                    \"chk_visaapplicant_12\": [\r\n                        true\r\n                    ],\r\n                    \"txt_familyname_13\": \"Yogesh\",\r\n                    \"txt_givenname_13\": \"Sonavane\",\r\n                    \"txt_dob_13\": \"23/11/2022\",\r\n                    \"txt_businorresidadd1_13\": \"TEST\",\r\n                    \"txt_businorresidadd3_13\": \"GUJARAT\",\r\n                    \"txt_postcode_13\": \"321654\",\r\n                    \"txt_mobile_13\": \"+919687747417\",\r\n                    \"chk_appprocess_15\": [\r\n                        true\r\n                    ],\r\n                    \"txt_typeofapp_15\": \"TEZT\",\r\n                    \"chk_notyetlodged_15\": [\r\n                        true\r\n                    ],\r\n                    \"chk_yes_17\": [\r\n                        true\r\n                    ],\r\n                    \"chk1_legalpractitioner_23\": [\r\n                        true\r\n                    ],\r\n                    \"chk1_legalpractitioner_24\": [\r\n                        true\r\n                    ]\r\n                }\r\n            ]\r\n        }\r\n    ],\r\n    \"udp\": \"{\\\"konsigndocumentid\\\":null,\\\"konsigndocumentbase64\\\":null,\\\"filename\\\":\\\"956\\\",\\\"applicantidf\\\":\\\"227242\\\",\\\"processidf\\\":\\\"36\\\",\\\"signdocumentid\\\":\\\"1\\\",\\\"requestid\\\":\\\"170843\\\",\\\"senduserid\\\":\\\"265448\\\",\\\"pdfid\\\":\\\"0\\\",\\\"leadassignedidf\\\":\\\"768679\\\",\\\"serviceid\\\":\\\"690\\\",\\\"companyid\\\":\\\"11412\\\",\\\"branchid\\\":\\\"0\\\",\\\"DocType\\\":\\\"956\\\"}\"\r\n}", null, "application/json");
											request.Content = content;
											var response = await client.SendAsync(request);
											response.EnsureSuccessStatusCode();
											Console.WriteLine(await response.Content.ReadAsStringAsync());


										
									
										{
											"head": {
												"responseTimestamp": "1526969112101",
												"version": "v1",
												"clientId": "C11",
												"signature": "TXBw50YPUKIgJd8gR8RpZuOMZ+csvCT7i0/YXmG//J8+BpFdY5goPBiLAkCzKlCkOvAQip/Op5aD6Vs+cNUTjFmC55JBxvp7WunZ45Ke2q0="
											},
											"body": {
												"resultInfo": {
													"resultStatus": "S",
													"resultCode": "0000",
													"resultMsg": "Success"
												},
												"txnToken": "fe795335ed3049c78a57271075f2199e1526969112097",
												"isPromoCodeValid": false,
												"authenticated": false
											}
										}