Documents

Send a reminder to a specific recipient

Immediately emails a reminder to a single pending recipient with an active signing link. Does not consume the automatic reminder budget.

post/v1/documents/{id}/recipients/{recipientId}/remind

Request

  • Base URL: https://api.signvoy.com
  • URL: https://api.signvoy.com/v1/documents/{id}/recipients/{recipientId}/remind
  • Auth: one of:
    • API key in header X-Workspace-Id
    • HTTP bearer
    • HTTP bearer

Path parameters

recipientIdstring uuid required

Recipient UUID

idstring uuid required

Document UUID

Response

idstring uuid required
workspaceIdstring uuid required
templateIdstring uuid required
templateVersionIdstring uuid required
ownerIdstring required

Clerk user ID of the document owner

namestring required

Human-readable document name

status'draft' | 'sent' | 'in_progress' | 'completed' | 'declined' | 'voided' | 'expired' required

Current document lifecycle state

routingMode'parallel' | 'sequential' required

Signing-order mode

messagestring

Custom message sent with the signing request

emailSubjectstring

Sender's replacement subject for the signing request and reminders. Absent means the generated subject is used.

createdAtinteger required

Creation timestamp (Unix ms)

sentAtinteger

Unix ms when sent

completedAtinteger

Unix ms when all signed

voidedAtinteger

Unix ms when voided

expiresAtinteger

Unix ms when expires/expired

documentHashstring

SHA-256 fingerprint of the certified final PDF

certifiedAtinteger

Unix ms when certified

reminderEnabledboolean required

Whether automatic reminders are enabled

reminderIntervalDaysinteger required

Days between automatic reminders

reminderMaxCountinteger required

Max automatic reminders

reminderCountinteger required

Automatic reminders sent so far

lastReminderAtinteger

Unix ms of the most recent reminder (auto or manual)

Changes

No recorded changes to this operation across all 1 revision of this API.