Skip to main content
POST
/
api
/
submissions
/
emails
Error
A valid request URL is required to generate request examples
[
  {
    "id": 123,
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "slug": "<string>",
    "email": "jsmith@example.com",
    "name": "<string>",
    "role": "<string>",
    "submission_id": 123,
    "embed_src": "<string>"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.spitshake.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Auth-Token
string
header
required

API token generated at Settings > API

Body

application/json
​
template_id
string
required

Template to use for each submission

​
emails
string
required

Comma-separated email addresses

Example:

"alice@example.com, bob@example.com, carol@example.com"

​
send_email
boolean
default:true

Send invitation emails to each submitter

​
name
string

Default name for all submitters

​
message
object
​
expire_at
string<date-time>

Expiration date for all created submissions

​
quick_sign_mode
enum<string>
default:confirmation_modal

Submission-level quick-sign mode for every created submission.

Available options:
normal,
review_and_sign,
auto_scroll_signature,
confirmation_modal
​
prefill_behavior
object

Submission-level prefill behavior for every created submission.

Response

Array of created submitters (one per email)

​
id
integer
​
uuid
string<uuid>
​
slug
string
​
email
string<email>
​
name
string | null
​
role
string
​
status
enum<string>
Available options:
waiting
​
submission_id
integer
​
embed_src
string

URL to embed or redirect the submitter to the signing page