Create a template (API key auth). Optionally instantiate and send to recipients.
curl --request POST \
--url https://api.useinkless.com/createNewTemplate \
--header 'Content-Type: multipart/form-data' \
--header 'x-api-key: <api-key>' \
--form 'templateName=<string>' \
--form 'fields=[
{
"id": "sig-1",
"x": 144,
"y": 418,
"page": 1,
"type": "Signature",
"recipient": 1
}
]' \
--form document='@example-file' \
--form 'emailSubject=<string>' \
--form 'recipients={
"name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>"
}' \
--form autoReleaseSignatures=trueimport requests
url = "https://api.useinkless.com/createNewTemplate"
files = { "document": ("example-file", open("example-file", "rb")) }
payload = {
"templateName": "<string>",
"fields": "[
{
\"id\": \"sig-1\",
\"x\": 144,
\"y\": 418,
\"page\": 1,
\"type\": \"Signature\",
\"recipient\": 1
}
]",
"emailSubject": "<string>",
"recipients": "{
\"name\": \"<string>\",
\"email\": \"jsmith@example.com\",
\"phone\": \"<string>\"
}",
"autoReleaseSignatures": "true"
}
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('templateName', '<string>');
form.append('fields', '[
{
"id": "sig-1",
"x": 144,
"y": 418,
"page": 1,
"type": "Signature",
"recipient": 1
}
]');
form.append('document', '<string>');
form.append('emailSubject', '<string>');
form.append('recipients', '{
"name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>"
}');
form.append('autoReleaseSignatures', 'true');
const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
options.body = form;
fetch('https://api.useinkless.com/createNewTemplate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.useinkless.com/createNewTemplate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"templateName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fields\"\r\n\r\n[\r\n {\r\n \"id\": \"sig-1\",\r\n \"x\": 144,\r\n \"y\": 418,\r\n \"page\": 1,\r\n \"type\": \"Signature\",\r\n \"recipient\": 1\r\n }\r\n]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"emailSubject\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients\"\r\n\r\n{\r\n \"name\": \"<string>\",\r\n \"email\": \"jsmith@example.com\",\r\n \"phone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"autoReleaseSignatures\"\r\n\r\ntrue\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.useinkless.com/createNewTemplate"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"templateName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fields\"\r\n\r\n[\r\n {\r\n \"id\": \"sig-1\",\r\n \"x\": 144,\r\n \"y\": 418,\r\n \"page\": 1,\r\n \"type\": \"Signature\",\r\n \"recipient\": 1\r\n }\r\n]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"emailSubject\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients\"\r\n\r\n{\r\n \"name\": \"<string>\",\r\n \"email\": \"jsmith@example.com\",\r\n \"phone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"autoReleaseSignatures\"\r\n\r\ntrue\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.useinkless.com/createNewTemplate")
.header("x-api-key", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"templateName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fields\"\r\n\r\n[\r\n {\r\n \"id\": \"sig-1\",\r\n \"x\": 144,\r\n \"y\": 418,\r\n \"page\": 1,\r\n \"type\": \"Signature\",\r\n \"recipient\": 1\r\n }\r\n]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"emailSubject\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients\"\r\n\r\n{\r\n \"name\": \"<string>\",\r\n \"email\": \"jsmith@example.com\",\r\n \"phone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"autoReleaseSignatures\"\r\n\r\ntrue\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useinkless.com/createNewTemplate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"templateName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fields\"\r\n\r\n[\r\n {\r\n \"id\": \"sig-1\",\r\n \"x\": 144,\r\n \"y\": 418,\r\n \"page\": 1,\r\n \"type\": \"Signature\",\r\n \"recipient\": 1\r\n }\r\n]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"emailSubject\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients\"\r\n\r\n{\r\n \"name\": \"<string>\",\r\n \"email\": \"jsmith@example.com\",\r\n \"phone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"autoReleaseSignatures\"\r\n\r\ntrue\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"message": "Template created successfully",
"template_id": "b4e2e25f-3a43-4e6c-9df9-3c6c1a2f13a1",
"s3_url": "templates/final.pdf",
"fields": [
[
{
"id": "sig-1",
"x": 144,
"y": 418,
"page": 1,
"type": "Signature",
"recipient": 1
}
]
]
}Endpoints
Create a new template
Creates a template from an uploaded PDF or DOCX and template fields. If recipients are provided, a PDF instance is immediately created from the template and recipient notifications are sent. See the guide for implementing createNewTemplate.
POST
/
createNewTemplate
Create a template (API key auth). Optionally instantiate and send to recipients.
curl --request POST \
--url https://api.useinkless.com/createNewTemplate \
--header 'Content-Type: multipart/form-data' \
--header 'x-api-key: <api-key>' \
--form 'templateName=<string>' \
--form 'fields=[
{
"id": "sig-1",
"x": 144,
"y": 418,
"page": 1,
"type": "Signature",
"recipient": 1
}
]' \
--form document='@example-file' \
--form 'emailSubject=<string>' \
--form 'recipients={
"name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>"
}' \
--form autoReleaseSignatures=trueimport requests
url = "https://api.useinkless.com/createNewTemplate"
files = { "document": ("example-file", open("example-file", "rb")) }
payload = {
"templateName": "<string>",
"fields": "[
{
\"id\": \"sig-1\",
\"x\": 144,
\"y\": 418,
\"page\": 1,
\"type\": \"Signature\",
\"recipient\": 1
}
]",
"emailSubject": "<string>",
"recipients": "{
\"name\": \"<string>\",
\"email\": \"jsmith@example.com\",
\"phone\": \"<string>\"
}",
"autoReleaseSignatures": "true"
}
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('templateName', '<string>');
form.append('fields', '[
{
"id": "sig-1",
"x": 144,
"y": 418,
"page": 1,
"type": "Signature",
"recipient": 1
}
]');
form.append('document', '<string>');
form.append('emailSubject', '<string>');
form.append('recipients', '{
"name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>"
}');
form.append('autoReleaseSignatures', 'true');
const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
options.body = form;
fetch('https://api.useinkless.com/createNewTemplate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.useinkless.com/createNewTemplate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"templateName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fields\"\r\n\r\n[\r\n {\r\n \"id\": \"sig-1\",\r\n \"x\": 144,\r\n \"y\": 418,\r\n \"page\": 1,\r\n \"type\": \"Signature\",\r\n \"recipient\": 1\r\n }\r\n]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"emailSubject\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients\"\r\n\r\n{\r\n \"name\": \"<string>\",\r\n \"email\": \"jsmith@example.com\",\r\n \"phone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"autoReleaseSignatures\"\r\n\r\ntrue\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.useinkless.com/createNewTemplate"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"templateName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fields\"\r\n\r\n[\r\n {\r\n \"id\": \"sig-1\",\r\n \"x\": 144,\r\n \"y\": 418,\r\n \"page\": 1,\r\n \"type\": \"Signature\",\r\n \"recipient\": 1\r\n }\r\n]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"emailSubject\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients\"\r\n\r\n{\r\n \"name\": \"<string>\",\r\n \"email\": \"jsmith@example.com\",\r\n \"phone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"autoReleaseSignatures\"\r\n\r\ntrue\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.useinkless.com/createNewTemplate")
.header("x-api-key", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"templateName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fields\"\r\n\r\n[\r\n {\r\n \"id\": \"sig-1\",\r\n \"x\": 144,\r\n \"y\": 418,\r\n \"page\": 1,\r\n \"type\": \"Signature\",\r\n \"recipient\": 1\r\n }\r\n]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"emailSubject\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients\"\r\n\r\n{\r\n \"name\": \"<string>\",\r\n \"email\": \"jsmith@example.com\",\r\n \"phone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"autoReleaseSignatures\"\r\n\r\ntrue\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useinkless.com/createNewTemplate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"templateName\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fields\"\r\n\r\n[\r\n {\r\n \"id\": \"sig-1\",\r\n \"x\": 144,\r\n \"y\": 418,\r\n \"page\": 1,\r\n \"type\": \"Signature\",\r\n \"recipient\": 1\r\n }\r\n]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"emailSubject\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients\"\r\n\r\n{\r\n \"name\": \"<string>\",\r\n \"email\": \"jsmith@example.com\",\r\n \"phone\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"autoReleaseSignatures\"\r\n\r\ntrue\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"message": "Template created successfully",
"template_id": "b4e2e25f-3a43-4e6c-9df9-3c6c1a2f13a1",
"s3_url": "templates/final.pdf",
"fields": [
[
{
"id": "sig-1",
"x": 144,
"y": 418,
"page": 1,
"type": "Signature",
"recipient": 1
}
]
]
}Authorizations
Body
multipart/form-data
Name for the template.
Template fields grouped by recipient index. Each inner array corresponds to the fields for a recipient. Sent as JSON within multipart.
Show child attributes
Show child attributes
The template PDF file to upload. Note that you can also upload a DOCX file here but will be converted to a PDF.
Optional custom subject for the email sent to recipients.
Optional. If provided, immediately creates a document instance and notifies recipients.
Show child attributes
Show child attributes
Optional. Default false if omitted.
⌘I
