Skip to main content
POST
/
api
/
submissions
/
html
Error
A valid request URL is required to generate request examples
{
  "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>",
      "email": "jsmith@example.com",
      "name": "<string>",
      "role": "<string>",
      "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>",
        "submitter_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "required": true,
        "readonly": true,
        "key": "<string>",
        "default_value": "<string>",
        "placeholder": "<string>",
        "pattern": "<string>",
        "options": [
          "<string>"
        ],
        "formula": "<string>",
        "areas": [
          {
            "x": 123,
            "y": 123,
            "w": 123,
            "h": 123,
            "page": 123,
            "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
    }
  ]
}

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
html
string
required
name
string
submitters
object[]
quick_sign_mode
enum<string>
default:confirmation_modal
Available options:
normal,
review_and_sign,
auto_scroll_signature,
confirmation_modal
prefill_behavior
object

Response

201 - application/json

Created submission

id
integer
slug
string
source
string
status
string
template_id
string
created_at
string<date-time>
updated_at
string<date-time>
completed_at
string<date-time> | null
expire_at
string<date-time> | null
submitters
object[]
audit_log
object[]
metadata
object
template
object
documents
object[]