Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/SDKs/go.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,8 @@ result, err := client.TurboSign.SendSignature(ctx, &turbodocx.SendSignatureReque
{
Type: "date",
RecipientEmail: "alice@example.com",
// Pins a fixed date in MM/DD/YYYY; omit to auto-fill the signing date
DefaultValue: "12/31/2026",
Template: &turbodocx.TemplateAnchor{
Anchor: "{DATE_ALICE}",
Placement: "replace",
Expand Down Expand Up @@ -551,7 +553,7 @@ The `Type` field accepts the following string values:
| `Y` | `int` | No\* | Y coordinate in pixels |
| `Width` | `int` | No\* | Field width in pixels |
| `Height` | `int` | No\* | Field height in pixels |
| `DefaultValue` | `string` | No | Pre-filled value |
| `DefaultValue` | `string` | No | Pre-filled value (checkbox: `"true"`/`"false"`; date: a fixed `MM/DD/YYYY`, omit to auto-fill the signing date) |
| `IsMultiline` | `bool` | No | Enable multiline for text fields |
| `IsReadonly` | `bool` | No | Make field read-only |
| `Required` | `bool` | No | Make field required |
Expand Down
6 changes: 4 additions & 2 deletions docs/SDKs/java.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,9 @@ public class Main {
.fields(Arrays.asList(
// Alice's signature
new Field("signature", 1, 100, 650, 200, 50, "alice@example.com"),
new Field("date", 1, 320, 650, 100, 30, "alice@example.com"),
// defaultValue pins a fixed date in MM/DD/YYYY; omit to auto-fill the signing date
new Field("date", 1, 320, 650, 100, 30, "alice@example.com",
"12/31/2026", null, null, null, null, null, null),
// Bob's signature
new Field("signature", 1, 100, 720, 200, 50, "bob@example.com"),
new Field("date", 1, 320, 720, 100, 30, "bob@example.com")
Expand Down Expand Up @@ -608,7 +610,7 @@ The coordinate-based constructor takes positional arguments in this order: `new
| `y` | `Integer` | No\* | Y coordinate in pixels |
| `width` | `Integer` | No\* | Field width in pixels |
| `height` | `Integer` | No\* | Field height in pixels |
| `defaultValue` | `String` | No | Pre-filled value |
| `defaultValue` | `String` | No | Pre-filled value (checkbox: `"true"`/`"false"`; date: a fixed `MM/DD/YYYY`, omit to auto-fill the signing date) |
| `isMultiline` | `Boolean` | No | Enable multiline for text fields |
| `isReadonly` | `Boolean` | No | Make field read-only |
| `required` | `Boolean` | No | Make field required |
Expand Down
4 changes: 3 additions & 1 deletion docs/SDKs/javascript.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,8 @@ TurboSign.configure({
width: 100,
height: 30,
recipientEmail: "alice@example.com",
// Pins a fixed date in MM/DD/YYYY; omit to auto-fill the signing date
defaultValue: "12/31/2026",
},
// Bob's signature
{
Expand Down Expand Up @@ -1193,7 +1195,7 @@ Field configuration supporting both coordinate-based and template-based position
| `y` | `number` | No\* | Y coordinate in pixels |
| `width` | `number` | No\* | Field width in pixels |
| `height` | `number` | No\* | Field height in pixels |
| `defaultValue` | `string` | No | Default value (for checkbox: `"true"` or `"false"`) |
| `defaultValue` | `string` | No | Default value (checkbox: `"true"`/`"false"`; date: a fixed `MM/DD/YYYY`, omit to auto-fill the signing date) |
| `isMultiline` | `boolean` | No | Enable multiline text |
| `isReadonly` | `boolean` | No | Make field read-only (pre-filled) |
| `required` | `boolean` | No | Whether field is required |
Expand Down
5 changes: 3 additions & 2 deletions docs/SDKs/php.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,8 @@ $result = TurboSign::sendSignature(
x: 320,
y: 650,
width: 100,
height: 30
height: 30,
defaultValue: '12/31/2026' // Pins a fixed date in MM/DD/YYYY; omit to auto-fill the signing date
),
// Bob's signature
new Field(
Expand Down Expand Up @@ -895,7 +896,7 @@ final class Field {
public ?int $width = null,
public ?int $height = null,
public ?TemplateConfig $template = null,
public ?string $defaultValue = null,
public ?string $defaultValue = null, // checkbox: 'true'/'false'; date: a fixed MM/DD/YYYY (omit to auto-fill the signing date)
public bool $isMultiline = false,
public bool $isReadonly = false,
public bool $required = false,
Expand Down
4 changes: 3 additions & 1 deletion docs/SDKs/python.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,8 @@ async def send_with_template():
{
"type": "date",
"recipientEmail": "alice@example.com",
# Pins a fixed date in MM/DD/YYYY; omit to auto-fill the signing date
"defaultValue": "12/31/2026",
"template": {
"anchor": "{DATE_ALICE}",
"placement": "replace",
Expand Down Expand Up @@ -616,7 +618,7 @@ Field configuration supporting both coordinate-based and template-based position
| `y` | `int` | No\* | Y coordinate in pixels |
| `width` | `int` | No\* | Field width in pixels |
| `height` | `int` | No\* | Field height in pixels |
| `defaultValue` | `str` | No | Default value (for checkbox: `"true"` or `"false"`) |
| `defaultValue` | `str` | No | Default value (checkbox: `"true"`/`"false"`; date: a fixed `MM/DD/YYYY`, omit to auto-fill the signing date) |
| `isMultiline` | `bool` | No | Enable multiline text |
| `isReadonly` | `bool` | No | Make field read-only (pre-filled) |
| `required` | `bool` | No | Whether field is required |
Expand Down
4 changes: 3 additions & 1 deletion docs/SDKs/ruby.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,8 @@ result = TurboDocxSdk::TurboSign.send_signature(
{
type: "date",
recipientEmail: "alice@example.com",
# Pins a fixed date in MM/DD/YYYY; omit to auto-fill the signing date
defaultValue: "12/31/2026",
template: {
anchor: "{DATE_ALICE}",
placement: "replace",
Expand Down Expand Up @@ -570,7 +572,7 @@ Field configuration supporting both coordinate-based and template-based position
| `y` | `Integer` | No\* | Y coordinate in pixels |
| `width` | `Integer` | No\* | Field width in pixels |
| `height` | `Integer` | No\* | Field height in pixels |
| `defaultValue` | `String` | No | Default value (for checkbox: `"true"` or `"false"`) |
| `defaultValue` | `String` | No | Default value (checkbox: `"true"`/`"false"`; date: a fixed `MM/DD/YYYY`, omit to auto-fill the signing date) |
| `isMultiline` | `Boolean` | No | Enable multiline text |
| `isReadonly` | `Boolean` | No | Make field read-only (pre-filled) |
| `required` | `Boolean` | No | Whether field is required |
Expand Down
8 changes: 6 additions & 2 deletions docs/TurboSign/API Signatures.md
Original file line number Diff line number Diff line change
Expand Up @@ -996,7 +996,7 @@ The `metadata` object allows you to customize the recipient's UI appearance:
| recipientEmail | String | Yes | Email address of recipient (matches email in recipients array) |
| type | String | Yes | Field type (see table above) |
| required | Boolean | No | Whether field must be completed (default: true) |
| defaultValue | String | No | Pre-filled value for the field |
| defaultValue | String | No | Pre-filled value for the field (max 600 characters) |
| isReadonly | Boolean | No | Makes field non-editable (for prefilled values) |
| backgroundColor | String | No | Custom background color (hex or rgba) |
| metadata | Object | No | Optional field metadata. Carries `fieldKey` (on a controlling checkbox) and/or a `conditional` rule (on a dependent field). See [Conditional (IF/THEN) Fields](#conditional-if-then-fields). |
Expand Down Expand Up @@ -1141,12 +1141,16 @@ dependent field exactly matches the `fieldKey` of an existing checkbox.
- Draws a signature pad for user input
- Can be text-based or drawn
- Cryptographically signed and hashed for legal validity
- Cannot carry a `defaultValue` — sending one is rejected

**date**

- Shows date picker interface
- Format: MM/DD/YYYY (US) or DD/MM/YYYY (configurable)
- Can set defaultValue to "today" for auto-population
- Fills automatically with the date the recipient signs
- To pin a specific date instead, set `defaultValue` to that date in `MM/DD/YYYY` format (e.g. `"12/31/2026"`). Omit `defaultValue` (or send `""`) to keep the signing-date behavior
- `defaultValue` must be a **real calendar date** in `MM/DD/YYYY` — a non-existent date such as `"02/31/2026"` (or any malformed value) is rejected with `400 InvalidDateValue`. There is no `"today"` keyword
- A date field cannot be `isReadonly` — a pinned date still shows to the signer, it is not locked

**full_name, first_name, last_name, email**

Expand Down
39 changes: 37 additions & 2 deletions docs/TurboSign/Setting up TurboSign.md
Original file line number Diff line number Diff line change
Expand Up @@ -297,14 +297,18 @@ Perfect for information you already know:
You can set default values for each recipient to pre-fill common information.

:::note Field Types Without Defaults
**Signature**, **Initials**, and **Date** fields cannot have default values because they must be completed by the recipient at signing time.
**Signature** and **Initials** fields cannot have default values because they must be drawn or typed by the recipient at signing time.

**Date** fields are a special case: they fill automatically with the date the recipient signs, so they need no default. If you need a specific date instead, you can pin one — see [Setting a Date Field's Value](#setting-a-date-fields-value) below.
:::

<br/>

### Setting Default Values Per Recipient

Default values are set per recipient and will pre-fill their fields.
Default values are set per recipient and will pre-fill their fields. There are **two places** to set them, and they edit the same value — whichever you use, the other updates to match.

#### Option 1: The Default Values accordion

**Step 1: Find the Default Values Accordion**

Expand All @@ -324,6 +328,36 @@ Fill in any of the available fields:

Use the recipient tabs at the top to set different default values for each signer.

#### Option 2: Directly on the field

If you have already placed a field on the document, you don't need to hunt for the accordion:

1. **Click the field** on the document.
2. The right panel opens with a **"Default Value for [field type]"** box.
3. **Type the value.** It saves as you type.

![Field properties panel showing the Default Value box for a Full name field](/img/turbosign/SetDefaultValueOnField.png)

The panel tells you the scope right underneath the box — *"Applies to every [field type] field for [recipient]"* — because this is the **same** value the accordion holds, not a per-field override. Change it here and every field of that type for that recipient changes too.

:::note Text fields work differently
A **Text** field's default is its own — each Text field keeps a separate value, since a free-text box usually means something different in each spot. Its panel says **"Default Value for This Field"** rather than naming a recipient.
:::

### Setting a Date Field's Value

A **Date** field fills in automatically with the date the recipient signs — for most documents that is exactly what you want, and you don't have to do anything.

If the document needs a **specific** date instead (an effective date, a policy start date), you can pin one:

1. **Click the Date field** on the document.
2. In the right panel, under **Date Value**, choose **"Use a fixed date"**.
3. **Pick the date.** It starts on today's date so you have something valid to adjust.

![Date field panel with "Use a fixed date" selected and a date chosen](/img/turbosign/SetDateFieldValue.png)

Choose **"Use the signing date"** to go back to the automatic behavior. The panel states which mode you're in underneath the control, so there's no guessing.

:::tip Character Limits
Each field has a maximum character limit. TurboSign will show you a character counter when you're approaching the limit so you don't lose any information.
:::
Expand Down Expand Up @@ -358,6 +392,7 @@ Now when Sarah receives the document, these fields will be pre-filled with this
**Don't:**
- ❌ **Don't force information** - Recipients can edit defaults if needed
- ❌ **Don't use for signatures/initials** - These fields must be completed during signing
- ❌ **Don't pin a date unless you mean it** - Date fields already fill with the signing date; only set a fixed date when the document needs that exact date
- ❌ **Don't include sensitive data** - Avoid passwords, SSNs, or confidential information
- ❌ **Don't overfill** - Only set defaults for information you truly know

Expand Down
Binary file added static/img/turbosign/SetDateFieldValue.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/turbosign/SetDefaultValueOnField.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading