Submissions
Create one-off submission from PDF
Create a submission directly from a PDF file without creating a reusable template first
POST
/
api
/
submissions
/
pdf
Create one-off submission from PDF
curl --request POST \
--url https://spitshake.io/api/submissions/pdf \
--header 'Content-Type: multipart/form-data' \
--header 'X-Auth-Token: <api-key>' \
--form file=@example-file \
--form 'name=<string>' \
--form 'submitters={
"email": "<string>",
"name": "<string>",
"role": "<string>"
}' \
--form 'fields={}' \
--form send_email=true \
--form quick_sign_mode=confirmation_modal \
--form 'prefill_behavior={
"skip_if_prefilled": true,
"editable_if_prefilled": false
}'import requests
url = "https://spitshake.io/api/submissions/pdf"
files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
"name": "<string>",
"submitters": "{
\"email\": \"<string>\",
\"name\": \"<string>\",
\"role\": \"<string>\"
}",
"fields": "{}",
"send_email": "true",
"quick_sign_mode": "confirmation_modal",
"prefill_behavior": "{
\"skip_if_prefilled\": true,
\"editable_if_prefilled\": false
}"
}
headers = {"X-Auth-Token": "<api-key>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('file', '<string>');
form.append('name', '<string>');
form.append('submitters', '{
"email": "<string>",
"name": "<string>",
"role": "<string>"
}');
form.append('fields', '{}');
form.append('send_email', 'true');
form.append('quick_sign_mode', 'confirmation_modal');
form.append('prefill_behavior', '{
"skip_if_prefilled": true,
"editable_if_prefilled": false
}');
const options = {method: 'POST', headers: {'X-Auth-Token': '<api-key>'}};
options.body = form;
fetch('https://spitshake.io/api/submissions/pdf', 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/submissions/pdf",
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=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"submitters\"\r\n\r\n{\r\n \"email\": \"<string>\",\r\n \"name\": \"<string>\",\r\n \"role\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fields\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_email\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"quick_sign_mode\"\r\n\r\nconfirmation_modal\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"prefill_behavior\"\r\n\r\n{\r\n \"skip_if_prefilled\": true,\r\n \"editable_if_prefilled\": false\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/submissions/pdf"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"submitters\"\r\n\r\n{\r\n \"email\": \"<string>\",\r\n \"name\": \"<string>\",\r\n \"role\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fields\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_email\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"quick_sign_mode\"\r\n\r\nconfirmation_modal\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"prefill_behavior\"\r\n\r\n{\r\n \"skip_if_prefilled\": true,\r\n \"editable_if_prefilled\": false\r\n}\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", 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.post("https://spitshake.io/api/submissions/pdf")
.header("X-Auth-Token", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"submitters\"\r\n\r\n{\r\n \"email\": \"<string>\",\r\n \"name\": \"<string>\",\r\n \"role\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fields\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_email\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"quick_sign_mode\"\r\n\r\nconfirmation_modal\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"prefill_behavior\"\r\n\r\n{\r\n \"skip_if_prefilled\": true,\r\n \"editable_if_prefilled\": false\r\n}\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://spitshake.io/api/submissions/pdf")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Auth-Token"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"submitters\"\r\n\r\n{\r\n \"email\": \"<string>\",\r\n \"name\": \"<string>\",\r\n \"role\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fields\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_email\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"quick_sign_mode\"\r\n\r\nconfirmation_modal\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"prefill_behavior\"\r\n\r\n{\r\n \"skip_if_prefilled\": true,\r\n \"editable_if_prefilled\": false\r\n}\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"id": 123,
"slug": "<string>",
"source": "<string>",
"status": "<string>",
"template_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"expire_at": "2023-11-07T05:31:56Z",
"submitters": [
{
"id": 123,
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"signing_url": "https://sign.yourcompany.com/s/OGZGoWBpoM8nN8",
"email": "jsmith@example.com",
"name": "<string>",
"role": "<string>",
"status": "waiting",
"submission_id": 123,
"opened_at": "2023-11-07T05:31:56Z",
"sent_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"phone": "<string>",
"external_id": "<string>",
"values": {},
"metadata": {},
"preferences": {},
"declined_at": "2023-11-07T05:31:56Z",
"documents": [
{
"name": "<string>",
"url": "<string>"
}
],
"submission_events": [
{}
],
"template": {
"id": 123,
"name": "<string>"
},
"submission": {
"id": 123,
"slug": "<string>",
"status": "<string>"
}
}
],
"audit_log": [
{}
],
"metadata": {},
"template": {
"id": "<string>",
"name": "<string>",
"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": [
{}
],
"documents": [
{
"id": 123,
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filename": "<string>",
"page_count": 123,
"page_dimensions": [
{
"width": 123,
"height": 123
}
],
"url": "<string>"
}
]
},
"documents": [
{
"id": 123,
"filename": "<string>",
"document_type": "<string>",
"byte_size": 123
}
]
}Authorizations
ApiTokenSessionCookie
API token generated at Settings > API
Body
multipart/form-data
Response
201 - application/json
Created submission
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
Create one-off submission from PDF
curl --request POST \
--url https://spitshake.io/api/submissions/pdf \
--header 'Content-Type: multipart/form-data' \
--header 'X-Auth-Token: <api-key>' \
--form file=@example-file \
--form 'name=<string>' \
--form 'submitters={
"email": "<string>",
"name": "<string>",
"role": "<string>"
}' \
--form 'fields={}' \
--form send_email=true \
--form quick_sign_mode=confirmation_modal \
--form 'prefill_behavior={
"skip_if_prefilled": true,
"editable_if_prefilled": false
}'import requests
url = "https://spitshake.io/api/submissions/pdf"
files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
"name": "<string>",
"submitters": "{
\"email\": \"<string>\",
\"name\": \"<string>\",
\"role\": \"<string>\"
}",
"fields": "{}",
"send_email": "true",
"quick_sign_mode": "confirmation_modal",
"prefill_behavior": "{
\"skip_if_prefilled\": true,
\"editable_if_prefilled\": false
}"
}
headers = {"X-Auth-Token": "<api-key>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('file', '<string>');
form.append('name', '<string>');
form.append('submitters', '{
"email": "<string>",
"name": "<string>",
"role": "<string>"
}');
form.append('fields', '{}');
form.append('send_email', 'true');
form.append('quick_sign_mode', 'confirmation_modal');
form.append('prefill_behavior', '{
"skip_if_prefilled": true,
"editable_if_prefilled": false
}');
const options = {method: 'POST', headers: {'X-Auth-Token': '<api-key>'}};
options.body = form;
fetch('https://spitshake.io/api/submissions/pdf', 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/submissions/pdf",
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=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"submitters\"\r\n\r\n{\r\n \"email\": \"<string>\",\r\n \"name\": \"<string>\",\r\n \"role\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fields\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_email\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"quick_sign_mode\"\r\n\r\nconfirmation_modal\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"prefill_behavior\"\r\n\r\n{\r\n \"skip_if_prefilled\": true,\r\n \"editable_if_prefilled\": false\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/submissions/pdf"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"submitters\"\r\n\r\n{\r\n \"email\": \"<string>\",\r\n \"name\": \"<string>\",\r\n \"role\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fields\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_email\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"quick_sign_mode\"\r\n\r\nconfirmation_modal\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"prefill_behavior\"\r\n\r\n{\r\n \"skip_if_prefilled\": true,\r\n \"editable_if_prefilled\": false\r\n}\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", 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.post("https://spitshake.io/api/submissions/pdf")
.header("X-Auth-Token", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"submitters\"\r\n\r\n{\r\n \"email\": \"<string>\",\r\n \"name\": \"<string>\",\r\n \"role\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fields\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_email\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"quick_sign_mode\"\r\n\r\nconfirmation_modal\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"prefill_behavior\"\r\n\r\n{\r\n \"skip_if_prefilled\": true,\r\n \"editable_if_prefilled\": false\r\n}\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://spitshake.io/api/submissions/pdf")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Auth-Token"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"submitters\"\r\n\r\n{\r\n \"email\": \"<string>\",\r\n \"name\": \"<string>\",\r\n \"role\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fields\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_email\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"quick_sign_mode\"\r\n\r\nconfirmation_modal\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"prefill_behavior\"\r\n\r\n{\r\n \"skip_if_prefilled\": true,\r\n \"editable_if_prefilled\": false\r\n}\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"id": 123,
"slug": "<string>",
"source": "<string>",
"status": "<string>",
"template_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"expire_at": "2023-11-07T05:31:56Z",
"submitters": [
{
"id": 123,
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"signing_url": "https://sign.yourcompany.com/s/OGZGoWBpoM8nN8",
"email": "jsmith@example.com",
"name": "<string>",
"role": "<string>",
"status": "waiting",
"submission_id": 123,
"opened_at": "2023-11-07T05:31:56Z",
"sent_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"phone": "<string>",
"external_id": "<string>",
"values": {},
"metadata": {},
"preferences": {},
"declined_at": "2023-11-07T05:31:56Z",
"documents": [
{
"name": "<string>",
"url": "<string>"
}
],
"submission_events": [
{}
],
"template": {
"id": 123,
"name": "<string>"
},
"submission": {
"id": 123,
"slug": "<string>",
"status": "<string>"
}
}
],
"audit_log": [
{}
],
"metadata": {},
"template": {
"id": "<string>",
"name": "<string>",
"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": [
{}
],
"documents": [
{
"id": 123,
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filename": "<string>",
"page_count": 123,
"page_dimensions": [
{
"width": 123,
"height": 123
}
],
"url": "<string>"
}
]
},
"documents": [
{
"id": 123,
"filename": "<string>",
"document_type": "<string>",
"byte_size": 123
}
]
}
