Submissions
Create one-off submission from HTML
POST
/
api
/
submissions
/
html
Create one-off submission from HTML
curl --request POST \
--url https://spitshake.io/api/submissions/html \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--data '
{
"html": "<string>",
"name": "<string>",
"submitters": [
{}
],
"quick_sign_mode": "confirmation_modal",
"prefill_behavior": {
"skip_if_prefilled": true,
"editable_if_prefilled": false
}
}
'import requests
url = "https://spitshake.io/api/submissions/html"
payload = {
"html": "<string>",
"name": "<string>",
"submitters": [{}],
"quick_sign_mode": "confirmation_modal",
"prefill_behavior": {
"skip_if_prefilled": True,
"editable_if_prefilled": False
}
}
headers = {
"X-Auth-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Auth-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
html: '<string>',
name: '<string>',
submitters: [{}],
quick_sign_mode: 'confirmation_modal',
prefill_behavior: {skip_if_prefilled: true, editable_if_prefilled: false}
})
};
fetch('https://spitshake.io/api/submissions/html', 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/html",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'html' => '<string>',
'name' => '<string>',
'submitters' => [
[
]
],
'quick_sign_mode' => 'confirmation_modal',
'prefill_behavior' => [
'skip_if_prefilled' => true,
'editable_if_prefilled' => false
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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/html"
payload := strings.NewReader("{\n \"html\": \"<string>\",\n \"name\": \"<string>\",\n \"submitters\": [\n {}\n ],\n \"quick_sign_mode\": \"confirmation_modal\",\n \"prefill_behavior\": {\n \"skip_if_prefilled\": true,\n \"editable_if_prefilled\": false\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Auth-Token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
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/html")
.header("X-Auth-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"html\": \"<string>\",\n \"name\": \"<string>\",\n \"submitters\": [\n {}\n ],\n \"quick_sign_mode\": \"confirmation_modal\",\n \"prefill_behavior\": {\n \"skip_if_prefilled\": true,\n \"editable_if_prefilled\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://spitshake.io/api/submissions/html")
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["Content-Type"] = 'application/json'
request.body = "{\n \"html\": \"<string>\",\n \"name\": \"<string>\",\n \"submitters\": [\n {}\n ],\n \"quick_sign_mode\": \"confirmation_modal\",\n \"prefill_behavior\": {\n \"skip_if_prefilled\": true,\n \"editable_if_prefilled\": false\n }\n}"
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
application/json
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 HTML
curl --request POST \
--url https://spitshake.io/api/submissions/html \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--data '
{
"html": "<string>",
"name": "<string>",
"submitters": [
{}
],
"quick_sign_mode": "confirmation_modal",
"prefill_behavior": {
"skip_if_prefilled": true,
"editable_if_prefilled": false
}
}
'import requests
url = "https://spitshake.io/api/submissions/html"
payload = {
"html": "<string>",
"name": "<string>",
"submitters": [{}],
"quick_sign_mode": "confirmation_modal",
"prefill_behavior": {
"skip_if_prefilled": True,
"editable_if_prefilled": False
}
}
headers = {
"X-Auth-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Auth-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
html: '<string>',
name: '<string>',
submitters: [{}],
quick_sign_mode: 'confirmation_modal',
prefill_behavior: {skip_if_prefilled: true, editable_if_prefilled: false}
})
};
fetch('https://spitshake.io/api/submissions/html', 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/html",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'html' => '<string>',
'name' => '<string>',
'submitters' => [
[
]
],
'quick_sign_mode' => 'confirmation_modal',
'prefill_behavior' => [
'skip_if_prefilled' => true,
'editable_if_prefilled' => false
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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/html"
payload := strings.NewReader("{\n \"html\": \"<string>\",\n \"name\": \"<string>\",\n \"submitters\": [\n {}\n ],\n \"quick_sign_mode\": \"confirmation_modal\",\n \"prefill_behavior\": {\n \"skip_if_prefilled\": true,\n \"editable_if_prefilled\": false\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Auth-Token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
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/html")
.header("X-Auth-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"html\": \"<string>\",\n \"name\": \"<string>\",\n \"submitters\": [\n {}\n ],\n \"quick_sign_mode\": \"confirmation_modal\",\n \"prefill_behavior\": {\n \"skip_if_prefilled\": true,\n \"editable_if_prefilled\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://spitshake.io/api/submissions/html")
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["Content-Type"] = 'application/json'
request.body = "{\n \"html\": \"<string>\",\n \"name\": \"<string>\",\n \"submitters\": [\n {}\n ],\n \"quick_sign_mode\": \"confirmation_modal\",\n \"prefill_behavior\": {\n \"skip_if_prefilled\": true,\n \"editable_if_prefilled\": false\n }\n}"
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
}
]
}
