docs(turbosign): reminders/expiration + quote scheduling across the API reference and SDK docs - #128
Merged
amitsharma-turbodocx merged 3 commits intoAug 24, 2026
Conversation
…r endpoint
The API gained a reminder + expiration surface that the reference did not cover:
callers could not discover the new endpoint, the eight per-document schedule
fields, or the new terminal `expired` status.
Adds:
- **Endpoint 6: Send Reminder** — the standalone nudge. Documents the optional
`recipientIds` (omit to remind everyone eligible), every `status` value a
recipient can come back with including why they were skipped, the
all-or-nothing 400, and the 409 `DocumentNotActionable` for a document whose
window has closed.
- **The schedule fields** on both send endpoints' request-body table, with the
detail that trips people up first: durations are `{value, unit}` objects sent
as JSON strings, because multipart/form-data cannot carry a nested value.
- **A Reminders & Expiration reference section** — the defaults table, the
two-track model (reminders keep running alongside warnings, coordinated so a
signer never gets both at once), how `expiresAt` and the 410 work, and the five
validation codes with the canonical mistake they prevent ("remind every 4 days"
with "expire in 2 days" sends zero reminders).
Emphasises throughout that both features are off by default, so an existing
integration that sends none of these fields behaves exactly as it does today.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
yacinekahlerras-turbodocx
marked this pull request as ready for review
July 31, 2026 16:34
…unds - API Signatures: state the maxReminders cap (max 50) and Duration bounds (max 999 days / 23976 hours); renumber Send Reminder to Endpoint 7 (after the Get Recipients endpoint on develop) and fix the Resend Email cross-reference. - Base SDK docs (docs/SDKs/*.md): add the reminder/expiration surface that was missing entirely - schedule-on-send, sendReminder, getStatus expiresAt, and the terminal expired status. - Quote SDK docs (docs/SDKs/quote-*.md): document quote-send scheduling with the validUntil-pin constraint (expireAfter ignored, cadence must fit). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…reminders-expiration # Conflicts: # docs/SDKs/go.md # docs/SDKs/java.md # docs/SDKs/javascript.md # docs/SDKs/php.md # docs/SDKs/python.md # docs/SDKs/ruby.md
amitsharma-turbodocx
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents the TurboSign reminders + expiration feature (and its TurboQuote extension) across the whole docs surface — the HTTP API reference and the per-language SDK docs, which had no coverage of it.
API reference —
docs/TurboSign/API Signatures.mdremindersEnabled,reminderDelay,reminderInterval,maxReminders,expirationEnabled,expireAfter,expirationWarning,expirationWarningInterval) with defaults and bounds (maxReminders−1…50; Duration 1…999 days / 23976 hours), on both send paths.expiresAt, and the terminalexpiredstatus (410 on an expired signing link).SDK docs —
docs/SDKs/*.md(previously zero reminder/expiration coverage)sendReminder,getStatus→expiresAt, and theexpiredstatus.quote-*.md): TurboQuote send scheduling, with the constraint that a quote's signature expiry is pinned to itsvalidUntil—expireAfteris ignored when expiration is on, and the reminder/warning cadence must fit insidevalidUntil.Merged with
developso the endpoint numbering and the new Get Recipients cross-references resolve correctly; Cloudflare Pages build should stay green.🤖 Generated with Claude Code