Settings
Update settings
PUT
/
api
/
settings
Update settings
curl --request PUT \
--url https://spitshake.io/api/settings \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--data '
{
"settings": {
"completion_message": "<string>",
"redirect_url": "<string>",
"logo_url": "<string>",
"company_name": "<string>",
"sms_sender_name": "<string>",
"sms_invitation_template": "{{company_name}} invited you to sign: {{signing_url}}",
"sms_otp_template": "Your {{company_name}} verification code is {{code}}",
"attach_documents_to_emails": true,
"signature_id_enabled": true,
"download_enabled": true,
"digital_signing_enabled": true,
"enhanced_fingerprinting_enabled": true,
"fingerprint_geolocation_enabled": true,
"reminder_days": [
123
],
"company_stamp_url": "<string>",
"company_stamp_text": "<string>",
"admin_ip_allowlist": [
"<string>"
]
},
"preview": false
}
'import requests
url = "https://spitshake.io/api/settings"
payload = {
"settings": {
"completion_message": "<string>",
"redirect_url": "<string>",
"logo_url": "<string>",
"company_name": "<string>",
"sms_sender_name": "<string>",
"sms_invitation_template": "{{company_name}} invited you to sign: {{signing_url}}",
"sms_otp_template": "Your {{company_name}} verification code is {{code}}",
"attach_documents_to_emails": True,
"signature_id_enabled": True,
"download_enabled": True,
"digital_signing_enabled": True,
"enhanced_fingerprinting_enabled": True,
"fingerprint_geolocation_enabled": True,
"reminder_days": [123],
"company_stamp_url": "<string>",
"company_stamp_text": "<string>",
"admin_ip_allowlist": ["<string>"]
},
"preview": False
}
headers = {
"X-Auth-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Auth-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
settings: {
completion_message: '<string>',
redirect_url: '<string>',
logo_url: '<string>',
company_name: '<string>',
sms_sender_name: '<string>',
sms_invitation_template: '{{company_name}} invited you to sign: {{signing_url}}',
sms_otp_template: 'Your {{company_name}} verification code is {{code}}',
attach_documents_to_emails: true,
signature_id_enabled: true,
download_enabled: true,
digital_signing_enabled: true,
enhanced_fingerprinting_enabled: true,
fingerprint_geolocation_enabled: true,
reminder_days: [123],
company_stamp_url: '<string>',
company_stamp_text: '<string>',
admin_ip_allowlist: ['<string>']
},
preview: false
})
};
fetch('https://spitshake.io/api/settings', 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/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'settings' => [
'completion_message' => '<string>',
'redirect_url' => '<string>',
'logo_url' => '<string>',
'company_name' => '<string>',
'sms_sender_name' => '<string>',
'sms_invitation_template' => '{{company_name}} invited you to sign: {{signing_url}}',
'sms_otp_template' => 'Your {{company_name}} verification code is {{code}}',
'attach_documents_to_emails' => true,
'signature_id_enabled' => true,
'download_enabled' => true,
'digital_signing_enabled' => true,
'enhanced_fingerprinting_enabled' => true,
'fingerprint_geolocation_enabled' => true,
'reminder_days' => [
123
],
'company_stamp_url' => '<string>',
'company_stamp_text' => '<string>',
'admin_ip_allowlist' => [
'<string>'
]
],
'preview' => 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/settings"
payload := strings.NewReader("{\n \"settings\": {\n \"completion_message\": \"<string>\",\n \"redirect_url\": \"<string>\",\n \"logo_url\": \"<string>\",\n \"company_name\": \"<string>\",\n \"sms_sender_name\": \"<string>\",\n \"sms_invitation_template\": \"{{company_name}} invited you to sign: {{signing_url}}\",\n \"sms_otp_template\": \"Your {{company_name}} verification code is {{code}}\",\n \"attach_documents_to_emails\": true,\n \"signature_id_enabled\": true,\n \"download_enabled\": true,\n \"digital_signing_enabled\": true,\n \"enhanced_fingerprinting_enabled\": true,\n \"fingerprint_geolocation_enabled\": true,\n \"reminder_days\": [\n 123\n ],\n \"company_stamp_url\": \"<string>\",\n \"company_stamp_text\": \"<string>\",\n \"admin_ip_allowlist\": [\n \"<string>\"\n ]\n },\n \"preview\": false\n}")
req, _ := http.NewRequest("PUT", 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.put("https://spitshake.io/api/settings")
.header("X-Auth-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"settings\": {\n \"completion_message\": \"<string>\",\n \"redirect_url\": \"<string>\",\n \"logo_url\": \"<string>\",\n \"company_name\": \"<string>\",\n \"sms_sender_name\": \"<string>\",\n \"sms_invitation_template\": \"{{company_name}} invited you to sign: {{signing_url}}\",\n \"sms_otp_template\": \"Your {{company_name}} verification code is {{code}}\",\n \"attach_documents_to_emails\": true,\n \"signature_id_enabled\": true,\n \"download_enabled\": true,\n \"digital_signing_enabled\": true,\n \"enhanced_fingerprinting_enabled\": true,\n \"fingerprint_geolocation_enabled\": true,\n \"reminder_days\": [\n 123\n ],\n \"company_stamp_url\": \"<string>\",\n \"company_stamp_text\": \"<string>\",\n \"admin_ip_allowlist\": [\n \"<string>\"\n ]\n },\n \"preview\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://spitshake.io/api/settings")
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["Content-Type"] = 'application/json'
request.body = "{\n \"settings\": {\n \"completion_message\": \"<string>\",\n \"redirect_url\": \"<string>\",\n \"logo_url\": \"<string>\",\n \"company_name\": \"<string>\",\n \"sms_sender_name\": \"<string>\",\n \"sms_invitation_template\": \"{{company_name}} invited you to sign: {{signing_url}}\",\n \"sms_otp_template\": \"Your {{company_name}} verification code is {{code}}\",\n \"attach_documents_to_emails\": true,\n \"signature_id_enabled\": true,\n \"download_enabled\": true,\n \"digital_signing_enabled\": true,\n \"enhanced_fingerprinting_enabled\": true,\n \"fingerprint_geolocation_enabled\": true,\n \"reminder_days\": [\n 123\n ],\n \"company_stamp_url\": \"<string>\",\n \"company_stamp_text\": \"<string>\",\n \"admin_ip_allowlist\": [\n \"<string>\"\n ]\n },\n \"preview\": false\n}"
response = http.request(request)
puts response.read_body{
"settings": {}
}Authorizations
ApiTokenSessionCookie
API token generated at Settings > API
Body
application/json
Response
Updated settings, or rendered SMS previews when preview is true
- Option 1
- Option 2
⌘I
Update settings
curl --request PUT \
--url https://spitshake.io/api/settings \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--data '
{
"settings": {
"completion_message": "<string>",
"redirect_url": "<string>",
"logo_url": "<string>",
"company_name": "<string>",
"sms_sender_name": "<string>",
"sms_invitation_template": "{{company_name}} invited you to sign: {{signing_url}}",
"sms_otp_template": "Your {{company_name}} verification code is {{code}}",
"attach_documents_to_emails": true,
"signature_id_enabled": true,
"download_enabled": true,
"digital_signing_enabled": true,
"enhanced_fingerprinting_enabled": true,
"fingerprint_geolocation_enabled": true,
"reminder_days": [
123
],
"company_stamp_url": "<string>",
"company_stamp_text": "<string>",
"admin_ip_allowlist": [
"<string>"
]
},
"preview": false
}
'import requests
url = "https://spitshake.io/api/settings"
payload = {
"settings": {
"completion_message": "<string>",
"redirect_url": "<string>",
"logo_url": "<string>",
"company_name": "<string>",
"sms_sender_name": "<string>",
"sms_invitation_template": "{{company_name}} invited you to sign: {{signing_url}}",
"sms_otp_template": "Your {{company_name}} verification code is {{code}}",
"attach_documents_to_emails": True,
"signature_id_enabled": True,
"download_enabled": True,
"digital_signing_enabled": True,
"enhanced_fingerprinting_enabled": True,
"fingerprint_geolocation_enabled": True,
"reminder_days": [123],
"company_stamp_url": "<string>",
"company_stamp_text": "<string>",
"admin_ip_allowlist": ["<string>"]
},
"preview": False
}
headers = {
"X-Auth-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Auth-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
settings: {
completion_message: '<string>',
redirect_url: '<string>',
logo_url: '<string>',
company_name: '<string>',
sms_sender_name: '<string>',
sms_invitation_template: '{{company_name}} invited you to sign: {{signing_url}}',
sms_otp_template: 'Your {{company_name}} verification code is {{code}}',
attach_documents_to_emails: true,
signature_id_enabled: true,
download_enabled: true,
digital_signing_enabled: true,
enhanced_fingerprinting_enabled: true,
fingerprint_geolocation_enabled: true,
reminder_days: [123],
company_stamp_url: '<string>',
company_stamp_text: '<string>',
admin_ip_allowlist: ['<string>']
},
preview: false
})
};
fetch('https://spitshake.io/api/settings', 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/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'settings' => [
'completion_message' => '<string>',
'redirect_url' => '<string>',
'logo_url' => '<string>',
'company_name' => '<string>',
'sms_sender_name' => '<string>',
'sms_invitation_template' => '{{company_name}} invited you to sign: {{signing_url}}',
'sms_otp_template' => 'Your {{company_name}} verification code is {{code}}',
'attach_documents_to_emails' => true,
'signature_id_enabled' => true,
'download_enabled' => true,
'digital_signing_enabled' => true,
'enhanced_fingerprinting_enabled' => true,
'fingerprint_geolocation_enabled' => true,
'reminder_days' => [
123
],
'company_stamp_url' => '<string>',
'company_stamp_text' => '<string>',
'admin_ip_allowlist' => [
'<string>'
]
],
'preview' => 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/settings"
payload := strings.NewReader("{\n \"settings\": {\n \"completion_message\": \"<string>\",\n \"redirect_url\": \"<string>\",\n \"logo_url\": \"<string>\",\n \"company_name\": \"<string>\",\n \"sms_sender_name\": \"<string>\",\n \"sms_invitation_template\": \"{{company_name}} invited you to sign: {{signing_url}}\",\n \"sms_otp_template\": \"Your {{company_name}} verification code is {{code}}\",\n \"attach_documents_to_emails\": true,\n \"signature_id_enabled\": true,\n \"download_enabled\": true,\n \"digital_signing_enabled\": true,\n \"enhanced_fingerprinting_enabled\": true,\n \"fingerprint_geolocation_enabled\": true,\n \"reminder_days\": [\n 123\n ],\n \"company_stamp_url\": \"<string>\",\n \"company_stamp_text\": \"<string>\",\n \"admin_ip_allowlist\": [\n \"<string>\"\n ]\n },\n \"preview\": false\n}")
req, _ := http.NewRequest("PUT", 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.put("https://spitshake.io/api/settings")
.header("X-Auth-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"settings\": {\n \"completion_message\": \"<string>\",\n \"redirect_url\": \"<string>\",\n \"logo_url\": \"<string>\",\n \"company_name\": \"<string>\",\n \"sms_sender_name\": \"<string>\",\n \"sms_invitation_template\": \"{{company_name}} invited you to sign: {{signing_url}}\",\n \"sms_otp_template\": \"Your {{company_name}} verification code is {{code}}\",\n \"attach_documents_to_emails\": true,\n \"signature_id_enabled\": true,\n \"download_enabled\": true,\n \"digital_signing_enabled\": true,\n \"enhanced_fingerprinting_enabled\": true,\n \"fingerprint_geolocation_enabled\": true,\n \"reminder_days\": [\n 123\n ],\n \"company_stamp_url\": \"<string>\",\n \"company_stamp_text\": \"<string>\",\n \"admin_ip_allowlist\": [\n \"<string>\"\n ]\n },\n \"preview\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://spitshake.io/api/settings")
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["Content-Type"] = 'application/json'
request.body = "{\n \"settings\": {\n \"completion_message\": \"<string>\",\n \"redirect_url\": \"<string>\",\n \"logo_url\": \"<string>\",\n \"company_name\": \"<string>\",\n \"sms_sender_name\": \"<string>\",\n \"sms_invitation_template\": \"{{company_name}} invited you to sign: {{signing_url}}\",\n \"sms_otp_template\": \"Your {{company_name}} verification code is {{code}}\",\n \"attach_documents_to_emails\": true,\n \"signature_id_enabled\": true,\n \"download_enabled\": true,\n \"digital_signing_enabled\": true,\n \"enhanced_fingerprinting_enabled\": true,\n \"fingerprint_geolocation_enabled\": true,\n \"reminder_days\": [\n 123\n ],\n \"company_stamp_url\": \"<string>\",\n \"company_stamp_text\": \"<string>\",\n \"admin_ip_allowlist\": [\n \"<string>\"\n ]\n },\n \"preview\": false\n}"
response = http.request(request)
puts response.read_body{
"settings": {}
}
