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.
Reusable Saved Fields
Saved fields let you create reusable field configurations that can be applied across multiple templates. Instead of re-configuring the same field properties (type, validation, default value, options) every time you create a template, save a field once and reuse it everywhere.How it works
- Configure a field with the desired properties (type, validation, options, default value, etc.).
- Save it via the API or the template builder UI.
- When creating or editing a template, select the saved field to instantly apply its configuration.
- Changes to a saved field do not retroactively update templates that already use it — each template gets a copy at the time of application.
API endpoints
List saved fields
Retrieve all saved fields for your account.GET /api/settings/saved_fields
Create a saved field
Save a new reusable field configuration.POST /api/settings/saved_fields
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Human-readable field name. |
type | string | Yes | Field type (text, signature, date, number, select, radio, checkbox, file, image, stamp, cells, phone, initials, payment, phone_verification, multi_select). |
required | boolean | No | Whether the field is required. Defaults to false. |
readonly | boolean | No | Whether the field is read-only. Defaults to false. |
key | string | No | Machine-readable key for API pre-filling. |
default_value | string or null | No | Default value shown when the signer opens the form. |
placeholder | string or null | No | Placeholder text shown in empty fields. |
validation | string or null | No | Validation preset name (e.g., "ssn", "ein", "email", "zip"). |
pattern | string or null | No | Custom regex validation pattern. |
options | array or null | No | Available choices for select, radio, and multi_select fields. |
description | string or null | No | Human-readable description for reference (not shown to signers). |
Delete a saved field
Remove a saved field from your account. This does not affect templates that already use a copy of this field.DELETE /api/settings/saved_fields/:id
204 No Content on success.
Error response (404 Not Found):
Using saved fields in templates
Via the template builder
In the template builder, the field palette includes a “Saved Fields” section below the standard field types. Click a saved field to place it on the document. The field inherits all saved properties (type, validation, default value, options, etc.).Via the API
When creating or updating a template schema, reference a saved field by including its properties. There is no special reference syntax — you copy the configuration into the schema:Saved fields are copied into the template schema when applied. Updating or deleting a saved field does not change templates that already use it.