Templates
Manage template documents
Add, remove, replace, or reorder documents in a template
PUT
/
api
/
templates
/
{id}
/
documents
Manage template documents
curl --request PUT \
--url https://spitshake.io/api/templates/{id}/documents \
--header 'Content-Type: multipart/form-data' \
--header 'X-Auth-Token: <api-key>' \
--form 'documents={
"file": "<string>",
"name": "<string>",
"document_id": 123,
"position": 123
}'import requests
url = "https://spitshake.io/api/templates/{id}/documents"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents\"\r\n\r\n{\r\n \"file\": \"<string>\",\r\n \"name\": \"<string>\",\r\n \"document_id\": 123,\r\n \"position\": 123\r\n}\r\n-----011000010111000001101001--"
headers = {
"X-Auth-Token": "<api-key>",
"Content-Type": "multipart/form-data"
}
response = requests.put(url, data=payload, headers=headers)
print(response.text)const form = new FormData();
form.append('documents', '{
"file": "<string>",
"name": "<string>",
"document_id": 123,
"position": 123
}');
const options = {method: 'PUT', headers: {'X-Auth-Token': '<api-key>'}};
options.body = form;
fetch('https://spitshake.io/api/templates/{id}/documents', 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://spitshake.io/api/templates/{id}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents\"\r\n\r\n{\r\n \"file\": \"<string>\",\r\n \"name\": \"<string>\",\r\n \"document_id\": 123,\r\n \"position\": 123\r\n}\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data",
"X-Auth-Token: <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://spitshake.io/api/templates/{id}/documents"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents\"\r\n\r\n{\r\n \"file\": \"<string>\",\r\n \"name\": \"<string>\",\r\n \"document_id\": 123,\r\n \"position\": 123\r\n}\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Auth-Token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://spitshake.io/api/templates/{id}/documents")
.header("X-Auth-Token", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents\"\r\n\r\n{\r\n \"file\": \"<string>\",\r\n \"name\": \"<string>\",\r\n \"document_id\": 123,\r\n \"position\": 123\r\n}\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://spitshake.io/api/templates/{id}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Auth-Token"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents\"\r\n\r\n{\r\n \"file\": \"<string>\",\r\n \"name\": \"<string>\",\r\n \"document_id\": 123,\r\n \"position\": 123\r\n}\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"template": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"external_id": "<string>",
"folder_name": "<string>",
"source": "<string>",
"shared": true,
"download_url": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"schema": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "text",
"submitter_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"required": true,
"readonly": true,
"key": "<string>",
"default_value": "<string>",
"placeholder": "<string>",
"pattern": "<string>",
"validation": "ssn",
"options": [
"<string>"
],
"formula": "<string>",
"areas": [
{
"x": 23.07,
"y": 20.35,
"w": 25,
"h": 5,
"page": 1,
"attachment_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"preferences": {}
}
],
"submitters": [
{
"name": "<string>",
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"preferences": {
"display_title": "Acme Legal Retainer",
"logo_url": "<string>",
"company_name": "<string>",
"favicon_url": "<string>",
"primary_button_color": "#2f5d8a",
"header_color": "#14213d",
"show_branding": true,
"brand_id": 7,
"custom_domain": "sign.example.com",
"signing_nav_style": "standard"
},
"documents": [
{
"id": 123,
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filename": "<string>",
"page_count": 123,
"page_dimensions": [
{
"width": 123,
"height": 123
}
],
"url": "<string>"
}
]
},
"results": [
{}
]
}⌘I
Manage template documents
curl --request PUT \
--url https://spitshake.io/api/templates/{id}/documents \
--header 'Content-Type: multipart/form-data' \
--header 'X-Auth-Token: <api-key>' \
--form 'documents={
"file": "<string>",
"name": "<string>",
"document_id": 123,
"position": 123
}'import requests
url = "https://spitshake.io/api/templates/{id}/documents"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents\"\r\n\r\n{\r\n \"file\": \"<string>\",\r\n \"name\": \"<string>\",\r\n \"document_id\": 123,\r\n \"position\": 123\r\n}\r\n-----011000010111000001101001--"
headers = {
"X-Auth-Token": "<api-key>",
"Content-Type": "multipart/form-data"
}
response = requests.put(url, data=payload, headers=headers)
print(response.text)const form = new FormData();
form.append('documents', '{
"file": "<string>",
"name": "<string>",
"document_id": 123,
"position": 123
}');
const options = {method: 'PUT', headers: {'X-Auth-Token': '<api-key>'}};
options.body = form;
fetch('https://spitshake.io/api/templates/{id}/documents', 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://spitshake.io/api/templates/{id}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents\"\r\n\r\n{\r\n \"file\": \"<string>\",\r\n \"name\": \"<string>\",\r\n \"document_id\": 123,\r\n \"position\": 123\r\n}\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data",
"X-Auth-Token: <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://spitshake.io/api/templates/{id}/documents"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents\"\r\n\r\n{\r\n \"file\": \"<string>\",\r\n \"name\": \"<string>\",\r\n \"document_id\": 123,\r\n \"position\": 123\r\n}\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Auth-Token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://spitshake.io/api/templates/{id}/documents")
.header("X-Auth-Token", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents\"\r\n\r\n{\r\n \"file\": \"<string>\",\r\n \"name\": \"<string>\",\r\n \"document_id\": 123,\r\n \"position\": 123\r\n}\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://spitshake.io/api/templates/{id}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Auth-Token"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents\"\r\n\r\n{\r\n \"file\": \"<string>\",\r\n \"name\": \"<string>\",\r\n \"document_id\": 123,\r\n \"position\": 123\r\n}\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"template": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"external_id": "<string>",
"folder_name": "<string>",
"source": "<string>",
"shared": true,
"download_url": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"schema": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "text",
"submitter_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"required": true,
"readonly": true,
"key": "<string>",
"default_value": "<string>",
"placeholder": "<string>",
"pattern": "<string>",
"validation": "ssn",
"options": [
"<string>"
],
"formula": "<string>",
"areas": [
{
"x": 23.07,
"y": 20.35,
"w": 25,
"h": 5,
"page": 1,
"attachment_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"preferences": {}
}
],
"submitters": [
{
"name": "<string>",
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"preferences": {
"display_title": "Acme Legal Retainer",
"logo_url": "<string>",
"company_name": "<string>",
"favicon_url": "<string>",
"primary_button_color": "#2f5d8a",
"header_color": "#14213d",
"show_branding": true,
"brand_id": 7,
"custom_domain": "sign.example.com",
"signing_nav_style": "standard"
},
"documents": [
{
"id": 123,
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filename": "<string>",
"page_count": 123,
"page_dimensions": [
{
"width": 123,
"height": 123
}
],
"url": "<string>"
}
]
},
"results": [
{}
]
}
