Update submitter
Update submitter details, set field values, send invitations, or mark as completed
curl --request PUT \
--url https://spitshake.io/api/submitters/{id} \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--data '
{
"email": "jsmith@example.com",
"name": "<string>",
"phone": "<string>",
"role": "<string>",
"external_id": "<string>",
"values": {},
"metadata": {},
"completed_redirect_url": "<string>",
"require_phone_2fa": true,
"fields": {},
"send_email": true,
"send_sms": true,
"completed": true
}
'import requests
url = "https://spitshake.io/api/submitters/{id}"
payload = {
"email": "jsmith@example.com",
"name": "<string>",
"phone": "<string>",
"role": "<string>",
"external_id": "<string>",
"values": {},
"metadata": {},
"completed_redirect_url": "<string>",
"require_phone_2fa": True,
"fields": {},
"send_email": True,
"send_sms": True,
"completed": True
}
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({
email: 'jsmith@example.com',
name: '<string>',
phone: '<string>',
role: '<string>',
external_id: '<string>',
values: {},
metadata: {},
completed_redirect_url: '<string>',
require_phone_2fa: true,
fields: {},
send_email: true,
send_sms: true,
completed: true
})
};
fetch('https://spitshake.io/api/submitters/{id}', 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/submitters/{id}",
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([
'email' => 'jsmith@example.com',
'name' => '<string>',
'phone' => '<string>',
'role' => '<string>',
'external_id' => '<string>',
'values' => [
],
'metadata' => [
],
'completed_redirect_url' => '<string>',
'require_phone_2fa' => true,
'fields' => [
],
'send_email' => true,
'send_sms' => true,
'completed' => true
]),
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/submitters/{id}"
payload := strings.NewReader("{\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"role\": \"<string>\",\n \"external_id\": \"<string>\",\n \"values\": {},\n \"metadata\": {},\n \"completed_redirect_url\": \"<string>\",\n \"require_phone_2fa\": true,\n \"fields\": {},\n \"send_email\": true,\n \"send_sms\": true,\n \"completed\": true\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/submitters/{id}")
.header("X-Auth-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"role\": \"<string>\",\n \"external_id\": \"<string>\",\n \"values\": {},\n \"metadata\": {},\n \"completed_redirect_url\": \"<string>\",\n \"require_phone_2fa\": true,\n \"fields\": {},\n \"send_email\": true,\n \"send_sms\": true,\n \"completed\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://spitshake.io/api/submitters/{id}")
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 \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"role\": \"<string>\",\n \"external_id\": \"<string>\",\n \"values\": {},\n \"metadata\": {},\n \"completed_redirect_url\": \"<string>\",\n \"require_phone_2fa\": true,\n \"fields\": {},\n \"send_email\": true,\n \"send_sms\": true,\n \"completed\": true\n}"
response = http.request(request)
puts response.read_body{
"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>"
}
}{
"error": "<string>",
"code": "invalid_field_values",
"errors": [
{
"code": "<string>",
"key": "<string>",
"field_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"field_name": "<string>",
"field_type": "<string>",
"message": "<string>",
"expected_count": 123,
"unmatched_count": 123,
"received_count": 123
}
],
"warnings": [
{
"code": "<string>",
"key": "<string>",
"field_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"field_name": "<string>",
"field_type": "<string>",
"message": "<string>",
"expected_count": 123,
"unmatched_count": 123,
"received_count": 123
}
]
}Authorizations
API token generated at Settings > API
Path Parameters
Body
Field values keyed by field UUID, field key, or normalized field name. Supports repeated-name fan-out and the same type-coercion rules as submission creation.
Where to send this signer after they complete; wins over the submission's and
the template's. Must be an absolute http/https URL (422 invalid_redirect_url
otherwise).
Field-level overrides
Send invitation email
Text this signer their signing link now, through the account's own SMS sender (requires phone)
Set to true to mark submitter as completed via API
Response
Updated submitter
Absolute signing link, minted on the submission's chosen host (preferences.custom_domain, then the template's, then the account's primary custom domain, then spitshake.io).
"https://sign.yourcompany.com/s/OGZGoWBpoM8nN8"
waiting, sent, opened, completed, declined, expired Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
curl --request PUT \
--url https://spitshake.io/api/submitters/{id} \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--data '
{
"email": "jsmith@example.com",
"name": "<string>",
"phone": "<string>",
"role": "<string>",
"external_id": "<string>",
"values": {},
"metadata": {},
"completed_redirect_url": "<string>",
"require_phone_2fa": true,
"fields": {},
"send_email": true,
"send_sms": true,
"completed": true
}
'import requests
url = "https://spitshake.io/api/submitters/{id}"
payload = {
"email": "jsmith@example.com",
"name": "<string>",
"phone": "<string>",
"role": "<string>",
"external_id": "<string>",
"values": {},
"metadata": {},
"completed_redirect_url": "<string>",
"require_phone_2fa": True,
"fields": {},
"send_email": True,
"send_sms": True,
"completed": True
}
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({
email: 'jsmith@example.com',
name: '<string>',
phone: '<string>',
role: '<string>',
external_id: '<string>',
values: {},
metadata: {},
completed_redirect_url: '<string>',
require_phone_2fa: true,
fields: {},
send_email: true,
send_sms: true,
completed: true
})
};
fetch('https://spitshake.io/api/submitters/{id}', 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/submitters/{id}",
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([
'email' => 'jsmith@example.com',
'name' => '<string>',
'phone' => '<string>',
'role' => '<string>',
'external_id' => '<string>',
'values' => [
],
'metadata' => [
],
'completed_redirect_url' => '<string>',
'require_phone_2fa' => true,
'fields' => [
],
'send_email' => true,
'send_sms' => true,
'completed' => true
]),
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/submitters/{id}"
payload := strings.NewReader("{\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"role\": \"<string>\",\n \"external_id\": \"<string>\",\n \"values\": {},\n \"metadata\": {},\n \"completed_redirect_url\": \"<string>\",\n \"require_phone_2fa\": true,\n \"fields\": {},\n \"send_email\": true,\n \"send_sms\": true,\n \"completed\": true\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/submitters/{id}")
.header("X-Auth-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"role\": \"<string>\",\n \"external_id\": \"<string>\",\n \"values\": {},\n \"metadata\": {},\n \"completed_redirect_url\": \"<string>\",\n \"require_phone_2fa\": true,\n \"fields\": {},\n \"send_email\": true,\n \"send_sms\": true,\n \"completed\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://spitshake.io/api/submitters/{id}")
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 \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"role\": \"<string>\",\n \"external_id\": \"<string>\",\n \"values\": {},\n \"metadata\": {},\n \"completed_redirect_url\": \"<string>\",\n \"require_phone_2fa\": true,\n \"fields\": {},\n \"send_email\": true,\n \"send_sms\": true,\n \"completed\": true\n}"
response = http.request(request)
puts response.read_body{
"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>"
}
}{
"error": "<string>",
"code": "invalid_field_values",
"errors": [
{
"code": "<string>",
"key": "<string>",
"field_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"field_name": "<string>",
"field_type": "<string>",
"message": "<string>",
"expected_count": 123,
"unmatched_count": 123,
"received_count": 123
}
],
"warnings": [
{
"code": "<string>",
"key": "<string>",
"field_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"field_name": "<string>",
"field_type": "<string>",
"message": "<string>",
"expected_count": 123,
"unmatched_count": 123,
"received_count": 123
}
]
}
