Skip to main content
POST
/
api
/
templates
/
{id}
/
remap_submitters
Error
A valid request URL is required to generate request examples
{
  "valid": true,
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "field_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "submitter_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "submitter_name": "<string>"
    }
  ],
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "field_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "submitter_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "submitter_name": "<string>"
    }
  ],
  "summary": {
    "total_fields": 123,
    "total_submitters": 123,
    "assignment_count": 123,
    "submitters": [
      {
        "submitter_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "submitter_name": "<string>",
        "field_count": 123,
        "signature_field_count": 123
      }
    ]
  },
  "dry_run": true,
  "updated": true,
  "changed_field_count": 123,
  "template": {
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "external_id": "<string>",
    "folder_name": "<string>",
    "source": "<string>",
    "shared": true,
    "download_url": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "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": [
      {
        "name": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "preferences": {},
    "documents": [
      {
        "id": 123,
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "filename": "<string>",
        "page_count": 123,
        "page_dimensions": [
          {
            "width": 123,
            "height": 123
          }
        ],
        "url": "<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

Path Parameters

​
id
integer
required

Body

application/json
​
field_assignments
object[]
required
​
dry_run
boolean
default:false

Validate and preview remap without persisting changes

​
required_signature_submitter_uuids
string<uuid>[]

Response

Remap completed or dry run successful

​
valid
boolean
​
errors
object[]
​
warnings
object[]
​
summary
object
​
dry_run
boolean
​
updated
boolean
​
changed_field_count
integer
​
template
object