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

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.

Servers

Path parameters

Name Type Required Description
document_id String Yes

The UUID of the document.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
recurrence_frequency_days Integer No

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

enabled Boolean Yes

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

delivery_method String No

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

Valid values:

  • "email"
  • "sms"
is_recurring Boolean No

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

initial_delay_days Integer No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.