Create Template with File Request (POST /v2.0/templates/create_with_files)
Creates a template with the file uploaded in the previous upload_file API and provided parameters.
Request Parameters
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {access_token} |
| app_auth_type | jsign-oauth2 |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| envelope | JSON Object | Yes | Contains envelope basic detail |
| envelope.name | String | Yes | Envelope name |
| envelope.description | String | No | Envelope description |
| envelope.categories | Array [String] | No | Envelope tags |
| envelope.signature | String | Yes | Signature type (e.g. "Esignature") |
| envelope.enable_element_tag | Boolean | No | Create document using element_tag |
| document | JSON Object | Yes | Contains each document's basic detail |
| document.request_id | String | Yes | Request ID that you get in the response of upload_file API |
| document.document_ref_no | Integer | Yes | Reference number of each document |
| document.name | String | Yes | Document name |
| recipients | JSON Object | Yes | Contains signers and observers information |
| recipients.signers[] | Array | Yes | Signers information along with annotation cordinates |
| recipients.signers[].signer_title | String | Yes | Signer's title |
| recipients.signers[].tabs | JSON Object | Yes | Contains information of coordinates for different fields |
| recipients.signers[].tabs.sign_here_tabs[] | Array | Yes | Contains information of sign annotation coordinates |
| recipients.signers[].tabs.sign_here_tabs[].x_position | Decimal | Yes | x position of an annotation |
| recipients.signers[].tabs.sign_here_tabs[].y_position | Decimal | Yes | y position of an annotation |
| recipients.signers[].tabs.sign_here_tabs[].w_position | Decimal | Yes | Width of an annotation |
| recipients.signers[].tabs.sign_here_tabs[].h_position | Decimal | Yes | Height of an annotation |
| recipients.signers[].tabs.sign_here_tabs[].x_position_percentage | Decimal | Yes | X coordinate in percentage |
| recipients.signers[].tabs.sign_here_tabs[].y_position_percentage | Decimal | Yes | Y coordinate in percentage |
| recipients.signers[].tabs.sign_here_tabs[].w_position_percentage | Decimal | Yes | Width in percentage |
| recipients.signers[].tabs.sign_here_tabs[].h_position_percentage | Decimal | Yes | Height in percentage |
| recipients.signers[].tabs.sign_here_tabs[].page_number | Array [Integer] | Yes | Page number |
| recipients.signers[].tabs.sign_here_tabs[].document_ref_no | Integer | Yes | Reference number of individual document |
| recipients.signers[].tabs.sign_here_tabs[].apply_to_all_pages | Boolean | No | Apply this annotation on all the pages |
| recipients.signers[].tabs.sign_here_tabs[].element_tag_string | String | Conditional | Element tag string to generate annotation |
| recipients.signers[].tabs.initial_tabs[] | JSON Array | No | Contains information of initial field coordinates |
| recipients.signers[].tabs.initial_tabs[].x_position | Decimal | Conditional | x position of an initial field |
| recipients.signers[].tabs.initial_tabs[].y_position | Decimal | Conditional | y position of an initial field |
| recipients.signers[].tabs.initial_tabs[].w_position | Decimal | Conditional | Width in percentage |
| recipients.signers[].tabs.initial_tabs[].x_position_percentage | Decimal | Conditional | X coordinate in an initial field |
| recipients.signers[].tabs.initial_tabs[].y_position_percentage | Decimal | Conditional | Y coordinate in an initial field |
| recipients.signers[].tabs.initial_tabs[].w_position_percentage | Decimal | Conditional | Width in percentage |
| recipients.signers[].tabs.initial_tabs[].page_number | Array [Integer] | Conditional | Page number |
| recipients.signers[].tabs.initial_tabs[].document_ref_no | Integer | Yes | Reference number of individual document |
| recipients.signers[].tabs.initial_tabs[].apply_to_all_pages | Boolean | Conditional | Apply this annotation on all the pages |
| recipients.signers[].tabs.initial_tabs[].element_tag_string | String | Conditional | Element tag string to generate annotation |
| recipients.signers[].tabs.name_tabs[] | JSON Array | No | Contains information of signer name field coordinates |
| recipients.signers[].tabs.name_tabs[].x_position | Decimal | Conditional | x position of a signer name field |
| recipients.signers[].tabs.name_tabs[].y_position | Decimal | Conditional | y position of a signer name field |
| recipients.signers[].tabs.name_tabs[].w_position | Decimal | Conditional | Width in percentage |
| recipients.signers[].tabs.name_tabs[].x_position_percentage | Decimal | Conditional | X coordinate in signer name field |
| recipients.signers[].tabs.name_tabs[].y_position_percentage | Decimal | Conditional | Y coordinate in signer name field |
| recipients.signers[].tabs.name_tabs[].w_position_percentage | Decimal | Conditional | Width in percentage |
| recipients.signers[].tabs.name_tabs[].page_number | Array [Integer] | Conditional | Page number |
| recipients.signers[].tabs.name_tabs[].document_ref_no | Integer | Yes | Reference number of individual document |
| recipients.signers[].tabs.name_tabs[].apply_to_all_pages | Boolean | Conditional | Apply this annotation on all the pages |
| recipients.signers[].tabs.name_tabs[].element_tag_string | String | Conditional | Element tag string to generate annotation |
| recipients.signers[].tabs.sign_date_tabs[] | JSON Array | No | Contains information of signing date field coordinates |
| recipients.signers[].tabs.sign_date_tabs[].x_position | Decimal | Conditional | x position of a signing date field |
| recipients.signers[].tabs.sign_date_tabs[].y_position | Decimal | Conditional | y position of a signing date field |
| recipients.signers[].tabs.sign_date_tabs[].w_position | Decimal | Conditional | Width in percentage |
| recipients.signers[].tabs.sign_date_tabs[].x_position_percentage | Decimal | Conditional | X coordinate in signing date field |
| recipients.signers[].tabs.sign_date_tabs[].y_position_percentage | Decimal | Conditional | Y coordinate in signing date field |
| recipients.signers[].tabs.sign_date_tabs[].w_position_percentage | Decimal | Conditional | Width in percentage |
| recipients.signers[].tabs.sign_date_tabs[].page_number | Array [Integer] | Conditional | Page number |
| recipients.signers[].tabs.sign_date_tabs[].document_ref_no | Integer | Yes | Reference number of individual document |
| recipients.signers[].tabs.sign_date_tabs[].apply_to_all_pages | Boolean | Conditional | Apply this annotation on all the pages |
| recipients.signers[].tabs.sign_date_tabs[].element_tag_string | String | Conditional | Element tag string to generate annotation |
| recipients.signers[].tabs.text_tabs[] | JSON Array | No | Contains information of signing date field coordinates |
| recipients.signers[].tabs.text_tabs[].x_position | Decimal | Conditional | X position of a signing date field |
| recipients.signers[].tabs.text_tabs[].y_position | Decimal | Conditional | Y position of a signing date field |
| recipients.signers[].tabs.text_tabs[].w_position | Decimal | Conditional | Width in position points |
| recipients.signers[].tabs.text_tabs[].h_position | Decimal | Conditional | Height in position points |
| recipients.signers[].tabs.text_tabs[].x_position_percentage | Decimal | Conditional | X coordinate of a signing date field |
| recipients.signers[].tabs.text_tabs[].y_position_percentage | Decimal | Conditional | Y coordinate of a signing date field |
| recipients.signers[].tabs.text_tabs[].w_position_percentage | Decimal | Conditional | Width in percentage |
| recipients.signers[].tabs.text_tabs[].h_position_percentage | Decimal | Conditional | Height in percentage |
| recipients.signers[].tabs.text_tabs[].page_number | Array [Integer] | Conditional | Page number |
| recipients.signers[].tabs.text_tabs[].document_ref_no | Integer | Yes | Reference number of individual document |
| recipients.signers[].tabs.text_tabs[].element_tag_string | String | Conditional | Element tag string to generate annotation |
| recipients.signers[].tabs.text_tabs[].required | Boolean | No | Make the text field mandatory for a signer |
| recipients.signers[].tabs.text_tabs[].text_property | JSON Object | Conditional | Textbox field properties |
| recipients.signers[].tabs.text_tabs[].text_property.alignment | String | Conditional | Textbox field value alignment (top, middle, bottom) |
| recipients.signers[].tabs.text_tabs[].text_property.placeholder | String | Conditional | Textbox field placeholder |
| recipients.signers[].tabs.text_tabs[].text_property.char_limit | Integer | Conditional | Textbox field allowed character limit |
| recipients.signers[].tabs.text_tabs[].text_property.char_limit_type | String | Conditional | Textbox field allowed character limit type (max, min, exact) |
| recipients.signers[].tabs.text_tabs[].text_property.validation_type | String | Conditional | Textbox field allowed value type (none, numberOnly, alphabetOnly) |
| recipients.signers[].tabs.custom_date_tabs[] | JSON Array | No | Contains information of custom date field coordinates |
| recipients.signers[].tabs.custom_date_tabs[].x_position | Decimal | Conditional | X position of a custom date field |
| recipients.signers[].tabs.custom_date_tabs[].y_position | Decimal | Conditional | Y position of a custom date field |
| recipients.signers[].tabs.custom_date_tabs[].w_position | Decimal | Conditional | W position of a custom date field |
| recipients.signers[].tabs.custom_date_tabs[].x_position_percentage | Decimal | Conditional | X coordinate percentage of a custom date field |
| recipients.signers[].tabs.custom_date_tabs[].y_position_percentage | Decimal | Conditional | Y coordinate percentage of a custom date field |
| recipients.signers[].tabs.custom_date_tabs[].w_position_percentage | Decimal | Conditional | W coordinate percentage of a custom date field |
| recipients.signers[].tabs.custom_date_tabs[].page_number | Array [Integer] | Conditional | Page number |
| recipients.signers[].tabs.custom_date_tabs[].document_ref_no | Integer | Yes | Reference number of individual document |
| recipients.signers[].tabs.custom_date_tabs[].element_tag_string | String | Conditional | Element tag string to generate annotation |
| recipients.signers[].tabs.custom_date_tabs[].required | Boolean | No | Make the custom date field mandatory for a signer |
| recipients.signers[].tabs.custom_date_tabs[].date_property | JSON Object | No | Custom date properties |
| recipients.signers[].tabs.custom_date_tabs[].date_property.placeholder | String | Conditional | Custom date field placeholder |
| recipients.signers[].tabs.checkbox_tabs | JSON Object | Conditional | Check box JSON Object |
| recipients.signers[].tabs.checkbox_tabs.groups[] | JSON Array | Conditional | Chec kbox group array |
| recipients.signers[].tabs.checkbox_tabs.groups[].group | String | Conditional | Group name |
| recipients.signers[].tabs.checkbox_tabs.groups[].validation_type | String | Conditional | Validation for the group |
| recipients.signers[].tabs.checkbox_tabs.checkboxes[] | JSON Array | Conditional | Check box array |
| recipients.signers[].tabs.checkbox_tabs.checkboxes[].x_position | Decimal | Conditional | X position of check box |
| recipients.signers[].tabs.checkbox_tabs.checkboxes[].y_position | Decimal | Conditional | Y position of check box |
| recipients.signers[].tabs.checkbox_tabs.checkboxes[].x_position_percentage | Decimal | Conditional | X coordinate percentage of check box |
| recipients.signers[].tabs.checkbox_tabs.checkboxes[].y_position_percentage | Decimal | Conditional | Y coordinate percentage of check box |
| recipients.signers[].tabs.checkbox_tabs.checkboxes[].page_number | Array [Integer] | Conditional | Page number |
| recipients.signers[].tabs.checkbox_tabs.checkboxes[].document_ref_no | Integer | Yes | Reference number of individual document |
| recipients.signers[].tabs.checkbox_tabs.checkboxes[].element_tag_string | String | Conditional | Element tag string to generate annotation |
| recipients.signers[].tabs.checkbox_tabs.checkboxes[].placeholder | String | No | Check box placeholder |
| recipients.signers[].tabs.checkbox_tabs.checkboxes[].group | String | No | Check box group |
| recipients.signers[].tabs.dropdown_tabs[] | JSON Array | Conditional | Dropdown JSON Array |
| recipients.signers[].tabs.dropdown_tabs[].x_position | Decimal | Conditional | X position of dropdown |
| recipients.signers[].tabs.dropdown_tabs[].y_position | Decimal | Conditional | Y position of dropdown |
| recipients.signers[].tabs.dropdown_tabs[].w_position | Decimal | Conditional | W position of dropdown |
| recipients.signers[].tabs.dropdown_tabs[].x_position_percentage | Decimal | Conditional | X coordinate percentage of dropdown |
| recipients.signers[].tabs.dropdown_tabs[].y_position_percentage | Decimal | Conditional | Y coordinate percentage of dropdown |
| recipients.signers[].tabs.dropdown_tabs[].w_position_percentage | Decimal | Conditional | W coordinate percentage of dropdown |
| recipients.signers[].tabs.dropdown_tabs[].page_number | Array [Integer] | Conditional | Page number |
| recipients.signers[].tabs.dropdown_tabs[].document_ref_no | Integer | Yes | Reference number of individual document |
| recipients.signers[].tabs.dropdown_tabs[].element_tag_string | String | Conditional | Element tag string to generate annotation |
| recipients.signers[].tabs.dropdown_tabs[].dropdown_property | JSON Object | Conditional | Dropdown property JSON object |
| recipients.signers[].tabs.dropdown_tabs[].dropdown_property.alignment | String | No | Dropdown alignment |
| recipients.signers[].tabs.dropdown_tabs[].dropdown_property.placeholder | String | No | Dropdown placeholder |
| recipients.signers[].tabs.dropdown_tabs[].dropdown_property.options[] | String Array | Conditional | Dropdown option |
| recipients.signers[].tabs.dropdown_tabs[].dropdown_property.default_option | String | No | Dropdown default option to be selected |
| recipients.signers[].tabs.image_tabs[] | JSON Array | Conditional | Image JSON Array |
| recipients.signers[].tabs.image_tabs[].x_position | Decimal | Conditional | X position of an image |
| recipients.signers[].tabs.image_tabs[].y_position | Decimal | Conditional | Y position of an image |
| recipients.signers[].tabs.image_tabs[].w_position | Decimal | Conditional | W position of an image |
| recipients.signers[].tabs.image_tabs[].h_position | Decimal | Conditional | H position of an image |
| recipients.signers[].tabs.image_tabs[].x_position_percentage | Decimal | Conditional | X coordinate percentage of image |
| recipients.signers[].tabs.image_tabs[].y_position_percentage | Decimal | Conditional | Y coordinate percentage of image |
| recipients.signers[].tabs.image_tabs[].w_position_percentage | Decimal | Conditional | W coordinate percentage of image |
| recipients.signers[].tabs.image_tabs[].h_position_percentage | Decimal | Conditional | H coordinate percentage of image |
| recipients.signers[].tabs.image_tabs[].page_number | Array [Integer] | Conditional | Page number |
| recipients.signers[].tabs.image_tabs[].document_ref_no | Integer | Yes | Reference number of individual document |
| recipients.signers[].tabs.image_tabs[].element_tag_string | String | Conditional | Element tag string to generate annotation |
| recipients.signers[].tabs.image_tabs[].required | Boolean | Conditional | Make the image field mandatory for signer |
| recipients.signers[].tabs.image_tabs[].image_property | JSON Object | Conditional | Image property JSON object |
| recipients.signers[].tabs.image_tabs[].image_property.placeholder | String | No | Image placeholder |
| recipients.observers[] | JSON Array | No | Signers information along with annotation cordinates |
| recipients.observers[].observer_title | String | Conditional | Observer's title |
Notes
X, Y, W, H are in point(pt) scale.
The formula to calculate percentages is:
-
xPercentage= ((x) / pageWidth * 10000) / 100;
-
yPercentage= ((y) / pageHeight * 10000) / 100;
-
wPercentage= ((w) / pageWidth * 10000) / 100;
-
hPercentage= ((h) / pageHeight * 10000) / 100;
Creating a template involves the following steps:
-
Upload File Request
-
Submit File Request
OR
-
Create template (with Base 64 file payload)
Response Parameters
Response Body Message Field
| Field | Value |
|---|---|
| message | Template saved successfully |
Response Body Data Fields
| Field | Always Preset | Notes |
|---|---|---|
| template_id | Yes | ID of the created template |
Sample Success Response - Fixed Position
REQUEST:
curl --location --request POST '/api/v2.0/templates/create_with_files' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2' \
--header 'Content-Type: application/json' \
--data-raw '{
"envelope": {
"name": "Sample Envelope Template",
"description": "This is an envelope test description",
"categories": [
"New Envelope",
"NDA"
],
"signature": "Esignature",
"enable_element_tag": false
},
"documents": [
{
"name": "Sample Document.pdf",
"request_id": "47031ad1-a151-4f26-8f9f-b4031beaec3a",
"document_ref_no": 1
},
{
"name": "Test Document.pdf",
"request_id": "bb7109c5-b47d-4f1c-8cae-db1baac39a4c",
"document_ref_no": 2
}
],
"recipients": {
"signers": [
{
"signer_title": "Signer 1",
"tabs": {
"sign_here_tabs": [
{
"x_position": 15,
"y_position": 15,
"w_position": 77.07,
"h_position": 46.28,
"x_position_percentage": 2,
"y_position_percentage": 1,
"w_position_percentage": 12,
"h_position_percentage": 5,
"page_number": [
1
],
"document_ref_no": 1
},
{
"x_position": 15,
"y_position": 15,
"w_position": 77.07,
"h_position": 46.28,
"x_position_percentage": 2,
"y_position_percentage": 1,
"w_position_percentage": 12,
"h_position_percentage": 5,
"page_number": [
1
],
"document_ref_no": 2
}
],
"initial_tabs": [
{
"x_position": 15,
"y_position": 70,
"w_position": 77.07,
"x_position_percentage": 2,
"y_position_percentage": 8,
"w_position_percentage": 12,
"page_number": [
1
],
"document_ref_no": 1
},
{
"x_position": 15,
"y_position": 70,
"w_position": 77.07,
"x_position_percentage": 2,
"y_position_percentage": 8,
"w_position_percentage": 12,
"page_number": [
1
],
"document_ref_no": 2
}
],
"name_tabs": [
{
"x_position": 15,
"y_position": 120,
"w_position": 127.07,
"x_position_percentage": 2,
"y_position_percentage": 15,
"w_position_percentage": 20,
"page_number": [
1
],
"document_ref_no": 1
},
{
"x_position": 15,
"y_position": 120,
"w_position": 127.07,
"x_position_percentage": 2,
"y_position_percentage": 15,
"w_position_percentage": 20,
"page_number": [
1
],
"document_ref_no": 2
}
],
"sign_date_tabs": [
{
"x_position": 15,
"y_position": 200,
"w_position": 107.07,
"x_position_percentage": 2,
"y_position_percentage": 25,
"w_position_percentage": 17,
"page_number": [
1
],
"document_ref_no": 1
},
{
"x_position": 15,
"y_position": 120,
"w_position": 127.07,
"x_position_percentage": 2,
"y_position_percentage": 15,
"w_position_percentage": 20,
"page_number": [
1
],
"document_ref_no": 2
}
],
"text_tabs": [
{
"x_position": 15,
"y_position": 250,
"w_position": 77.07,
"h_position": 46.24,
"x_position_percentage": 2,
"y_position_percentage": 31,
"w_position_percentage": 12,
"h_position_percentage": 5,
"page_number": [
1
],
"document_ref_no": 1,
"required": false,
"text_property": {
"alignment": "Bottom",
"placeholder": "textbox 1",
"char_limit": 100,
"char_limit_type": "max",
"validation_type": "none"
}
},
{
"x_position": 15,
"y_position": 250,
"w_position": 77.07,
"h_position": 46.24,
"x_position_percentage": 2,
"y_position_percentage": 31,
"w_position_percentage": 12,
"h_position_percentage": 5,
"page_number": [
1
],
"document_ref_no": 2,
"required": false,
"text_property": {
"alignment": "Bottom",
"placeholder": "textbox 1",
"char_limit": 100,
"char_limit_type": "max",
"validation_type": "none"
}
}
],
"custom_date_tabs": [
{
"x_position": 15,
"y_position": 300,
"w_position": 177.07,
"x_position_percentage": 2,
"y_position_percentage": 37,
"w_position_percentage": 28,
"page_number": [
1
],
"document_ref_no": 1,
"required": false,
"date_property": {
"placeholder": "textbox 1"
}
},
{
"x_position": 15,
"y_position": 300,
"w_position": 177.07,
"x_position_percentage": 2,
"y_position_percentage": 37,
"w_position_percentage": 28,
"page_number": [
1
],
"document_ref_no": 2,
"required": false,
"date_property": {
"placeholder": "textbox 1"
}
},
{
"checkbox_tabs": {
"groups": [
{
"group": "Group 1",
"validation_type": "none"
}
],
"checkboxes": [
{
"x_position": 15,
"y_position": 350,
"x_position_percentage": 2,
"y_position_percentage": 44,
"page_number": [
1
],
"document_ref_no": 1,
"placeholder": "Checkbox 1",
"group": "Group 1"
}
]
},
"dropdown_tabs": [
{
"x_position": 15,
"y_position": 400,
"w_position": 130.26,
"x_position_percentage": 2,
"y_position_percentage": 50,
"w_position_percentage": 21,
"page_number": [
1
],
"document_ref_no": 1,
"dropdown_property": {
"alignment": "bottom",
"placeholder": "Dropdown 1"
"options": [
"option 1",
"option 2",
"option 3",
],
"default_option": "option 2"
}
},
{
"x_position": 15,
"y_position": 400,
"w_position": 130.26,
"x_position_percentage": 2,
"y_position_percentage": 50,
"w_position_percentage": 21,
"page_number": [
1
],
"document_ref_no": 2,
"dropdown_property": {
"alignment": "bottom",
"placeholder": "Dropdown 1"
"options": [
"option 1",
"option 2",
"option 3",
],
"default_option": "option 2"
}
}
],
"image_tabs": [
{
"x_position": 15,
"y_position": 500,
"w_position": 100,
"h_position": 100,
"x_position_percentage": 2,
"y_position_percentage": 63,
"w_position_percentage": 16,
"h_position_percentage": 12,
"page_number": [
1
],
"document_ref_no": 1
},
"required": false,
"image_property": {
"placeholder": "Image 1"
}
}
]
}
}
],
"observers": [
{
"observer_title": "Observer 1"
}
]
}
}'
RESPONSE:
{
"message": "Template saved successfully",
"data": {
"template_id": "f8dc2152-c82e-4657-b04e-1b92d3532913"
}
}
Sample Success Response - Element Position
REQUEST:
curl --location --request POST '/api/v2.0/templates/create_with_files' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2' \
--header 'Content-Type: application/json' \
--data-raw '{
"envelope": {
"name": "Sample Envelope Template",
"description": "This is an envelope test description",
"categories": [
"New Envelope",
"NDA"
],
"signature": "Esignature",
"enable_element_tag": true
},
"documents": [
{
"name": "Sample Document.pdf",
"request_id": "4937ad6b-3270-4be6-8f47-114498646a94",
"document_ref_no": 1
},
{
"name": "Sample Document.pdf",
"request_id": "bb7109c5-b47d-4f1c-8cae-db1baac39a4c",
"document_ref_no": 2
}
],
"recipients": {
"signers": [
{
"signer_title": "Signer 1",
"tabs": {
"sign_here_tabs": [
{
"element_tag_string": "[Street Address]",
"page_number": [
1
],
"document_ref_no": 1
},
{
"element_tag_string": "is made on",
page_number": [
1
],
"document_ref_no": 2
}
],
"initial_tabs": [
{
"element_tag_string": "(such as this)",
"page_number": [
1
],
"document_ref_no": 1
},
{
"element_tag_string": "[Month,",
"page_number": [
1
],
"document_ref_no": 2
}
],
"name_tabs": [
{
"element_tag_string": "SHIPPED VIA",
"page_number": [
1
],
"document_ref_no": 1
},
{
"element_tag_string": "Parties",
"page_number": [
1
],
"document_ref_no": 2
}
],
"text_tabs": [
{
"element_tag_string": "QUANTITY",
"page_number": [
1
],
"document_ref_no": 1,
"required": false,
"text_property": {
"alignment": "bottom",
"placeholder": "textbox 1",
"char_limit": "100",
"char_limit_type": "max",
"validation_type": "none"
}
},
{
"element_tag_string": "may disclose",
"page_number": [
1
],
"document_ref_no": 2,
"required": false,
"text_property": {
"alignment": "bottom",
"placeholder": "textbox 1",
"char_limit": "100",
"char_limit_type": "max",
"validation_type": "none"
}
}
],
"custom_date_tabs": [
{
"element_tag_string": "Make all",
"page_number": [
1
],
"document_ref_no": 1,
"required": false,
"date_property": {
"placeholder": "textbox 1"
}
},
{
"element_tag_string": "consideration",
"page_number": [
1
],
"document_ref_no": 2,
"required": false,
"date_property": {
"placeholder": "textbox 1"
}
}
],
"checkbox_tabs": {
"groups": [
{
"group": "Group 1",
"validation_type": "none"
}
],
"checkboxes": [
{
"element_tag_string": "BUSINESS",
"page_number": [
1
],
"document_ref_no": 1,
"placeholder": "Checkbox 1",
"group": "Group 1"
}
]
},
"dropdown_tabs": [
{ "element_tag_string": "TOTAL DUE",
"page_number": [
1
],
"document_ref_no": 1,
"dropdown_property": {
"alignment": "bottom",
"placeholder": "Dropdown 1",
"options": [
"option 1",
"option 2",
"option 3"
],
"default_option": "option 2"
}
},
{
"element_tag_string": " all precautions",
"page_number": [
1
],
"document_ref_no": 2,
"dropdown_property": {
"alignment": "bottom",
"placeholder": "Dropdown 1",
"options": [
"option 1",
"option 2",
"option 3"
],
"default_option": "option 2"
}
},
{
"image_tabs": [
{
"element_tag_string": "#SignHere#",
"page_number": [
1
],
"document_ref_no": 1,
"required": false,
"image_property": {
"placeholder": "Image 1"
}
},
{
"element_tag_string": "was rightfully",
"page_number": [
1
],
"document_ref_no": 2,
"required": false,
"image_property": {
"placeholder": "Image 1"
}
}
]
}
}
],
"observers": [
{
"observer_title": "Observer 1"
}
]
}
}'
RESPONSE:
{
"message": "Template saved successfully",
"data": {
"template_id": "f2e4f43a-4dfb-4967-bd05-fb4bb90e77bc"
}
}
Sample Error Response
REQUEST:
curl --location --request POST '/api/v2.0/templates/create_with_files' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2' \
--header 'Content-Type: application/json' \
--data-raw '{
"envelope": {
"name": "Sample Envelope Template",
"description": "This is an envelope test description",
"categories": [
"New Envelope",
"NDA"
],
"signature": "Esignature",
"enable_element_tag": false
},
"documents": [
{
"request_id": "3ba00dba-6f6b-4d97-96eb-64c39b1f96de",
"document_ref_no": "1",
"name": "First Template Doc.pdf",
}
],
"recipients": {
"signers": [
{
"signer_title": "",
[The remainder as above, except signer title is not provided]...
RESPONSE:
{
"errors": [
{
"error_code": "SIGNER_TITLE_IS_REQUIRED",
developer_message": "SIGNER title cannot be null or empty"
}
]
}
Note: View the full list of applicable error code for this method here.