v1

latestOpenAPI 3.0.3MIT2026-07-24122271451.2 KB

Document Reminders

Update Document Auto Reminder Settings

Configures automatic reminders for document recipients. These reminders are sent after the document's initial dispatch. Settings include enabling reminders, delivery method (email/SMS), initial delay, and recurrence frequency.

patch/public/v1/documents/{document_id}/auto-reminders

Path parameters

document_idstring required

The UUID of the document.

Request body

enabledboolean required

Toggles auto-reminders for the document. If true, reminders are scheduled based on the configuration.

delivery_method'email' | 'sms'

The method used to deliver reminders (e.g., email, SMS).

initial_delay_daysinteger

Number of days to wait after sending the document before the first reminder is sent.

is_recurringboolean

If true, reminders will be sent repeatedly at specified intervals after the initial reminder.

recurrence_frequency_daysinteger

Number of days between recurring reminders, applicable if is_recurring is true.

Response

Auto reminder settings updated successfully.